brainy

soulcraft/brainy

Fork 0

Commit graph

Author	SHA1	Message	Date
David Snelling	adda1570f3	docs(8.0): Phase F — deep clean across 21 docs Aligned every public doc to the 8.0 contract: filesystem + memory adapters only, vector index provider terminology (config.vector with recall + quantization + persistMode knobs), no cloud storage adapters, no closed- source product names. Tier 1 — heavier rewrites: - docs/architecture/storage-architecture.md - docs/architecture/data-storage-architecture.md - docs/architecture/distributed-storage.md DELETED — content was 100% cloud-coordination examples with no 8.0 substance. - docs/guides/distributed-system.md DELETED — same reason; no inbound refs. - docs/SCALING.md rewritten for single-node guidance. - docs/PLUGINS.md, docs/augmentations/{COMPLETE-REFERENCE,README}.md: HnswProvider→VectorIndexProvider, hnsw→vector key. - docs/PERFORMANCE.md, docs/BATCHING.md cloud-detection + sharding sections replaced with single-node vector tuning + filesystem framing. Tier 2 — surgical renames + cloud-section deletions: - architecture/{index,initialization-and-rebuild,overview}.md - transactions.md, DEVELOPER_LEARNING_PATH.md - vfs/{VFS_API_GUIDE,COMMON_PATTERNS}.md - api/README.md, guides/{inspection,import-flow}.md Tier 3 — light edits: - docs/README.md, architecture/augmentation-system-audit.md MIGRATION-V3-TO-V4.md untouched (internal migration doc, no stale terms).	2026-06-09 16:13:35 -07:00
David Snelling	3c72afd41a	docs: comprehensive API documentation and examples overhaul - Add comprehensive JSDoc @example tags to all core methods (add, get, relate, find, similar, embed) - Add @deprecated warnings with migration paths for all v2.x APIs - Create VFS Quick Start Guide addressing brain-cloud integration issues - Create VFS Common Patterns guide preventing infinite recursion mistakes - Create Core API Patterns guide with modern v3.x usage examples - Create Neural API Patterns guide for AI-powered features - Create comprehensive API Decision Tree for choosing right methods - Update README with prominent VFS examples and file explorer patterns - Follow 2025 npm package documentation standards throughout 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-26 13:32:44 -07:00

Author

SHA1

Message

Date

David Snelling

adda1570f3

docs(8.0): Phase F — deep clean across 21 docs

Aligned every public doc to the 8.0 contract: filesystem + memory adapters
only, vector index provider terminology (config.vector with recall +
quantization + persistMode knobs), no cloud storage adapters, no closed-
source product names.

Tier 1 — heavier rewrites:
- docs/architecture/storage-architecture.md
- docs/architecture/data-storage-architecture.md
- docs/architecture/distributed-storage.md DELETED — content was 100%
  cloud-coordination examples with no 8.0 substance.
- docs/guides/distributed-system.md DELETED — same reason; no inbound refs.
- docs/SCALING.md rewritten for single-node guidance.
- docs/PLUGINS.md, docs/augmentations/{COMPLETE-REFERENCE,README}.md:
  HnswProvider→VectorIndexProvider, hnsw→vector key.
- docs/PERFORMANCE.md, docs/BATCHING.md cloud-detection + sharding
  sections replaced with single-node vector tuning + filesystem framing.

Tier 2 — surgical renames + cloud-section deletions:
- architecture/{index,initialization-and-rebuild,overview}.md
- transactions.md, DEVELOPER_LEARNING_PATH.md
- vfs/{VFS_API_GUIDE,COMMON_PATTERNS}.md
- api/README.md, guides/{inspection,import-flow}.md

Tier 3 — light edits:
- docs/README.md, architecture/augmentation-system-audit.md

MIGRATION-V3-TO-V4.md untouched (internal migration doc, no stale terms).

2026-06-09 16:13:35 -07:00

David Snelling

3c72afd41a

docs: comprehensive API documentation and examples overhaul

- Add comprehensive JSDoc @example tags to all core methods (add, get, relate, find, similar, embed)
- Add @deprecated warnings with migration paths for all v2.x APIs
- Create VFS Quick Start Guide addressing brain-cloud integration issues
- Create VFS Common Patterns guide preventing infinite recursion mistakes
- Create Core API Patterns guide with modern v3.x usage examples
- Create Neural API Patterns guide for AI-powered features
- Create comprehensive API Decision Tree for choosing right methods
- Update README with prominent VFS examples and file explorer patterns
- Follow 2025 npm package documentation standards throughout

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

2025-09-26 13:32:44 -07:00

2 commits