David Snelling
994276f09f
- Archived 13 API design iterations to docs/api-design-archive/ - Consolidated augmentation docs to docs/augmentations-archive/ - Maintained ONE definitive API doc at docs/api/README.md - Cleaned up documentation structure for 2.0 release - Preserved all historical documents for reference |
||
|---|---|---|
| .. | ||
| API-CRITICAL-FIXES.md | ||
| API-QUICK-REFERENCE.md | ||
| API-REFERENCE.md | ||
| BRAINY-2.0-COMPLETE-API.md | ||
| BRAINY-2.0-CORRECT-API.md | ||
| BRAINY-2.0-DETAILED-API.md | ||
| BRAINY-2.0-FINAL-API.md | ||
| BRAINY-2.0-FINAL-CORRECT-API.md | ||
| BRAINY-2.0-SIMPLIFIED-API.md | ||
| BRAINY-2.0-UNIFIED-API.md | ||
| COMPLETE-PUBLIC-API.md | ||
| CRITICAL-API-AUDIT.md | ||
| FINAL-2.0-PUBLIC-API.md | ||
| README.md | ||
API Design Archive
This directory contains historical API design documents from the Brainy 2.0 development process.
Purpose
These documents represent the iterative refinement of the Brainy 2.0 API during development. They are preserved here for historical reference and to document the design decisions made along the way.
Current API Documentation
The definitive API documentation is now located at:
/docs/api/README.md- The ONE official API reference
Archived Documents
These documents show the evolution of the API design:
- Various iterations of API structure
- Exploration of different naming conventions
- Refinement of the Triple Intelligence concept
- Transition from MongoDB operators to Brainy operators
- Evolution of the Neural API
Key Decisions Made
- Terminology: Vector + Graph + Metadata (not Field)
- Operators: Brainy operators (greaterThan, lessThan) not MongoDB ($gt, $lt)
- Methods: Specific noun/verb naming (addNoun, getNoun)
- Unification: Single getNouns() method instead of multiple variants
- Neural API: Complete clustering and visualization features
Note
These documents are archived, not deleted, to preserve the development history and rationale behind API decisions.