**feat(docs): add comprehensive architecture documentation for Brainy**
- **Documentation Additions**:
- Created `brainy_architecture_diagram.md` to detail Brainy's architecture using diagrams and structured descriptions:
- Added overviews of the system, core architecture, and augmentation pipeline.
- Defined data models, graph structures, storage architecture, and performance optimizations.
- Explained vector search engine design, HNSW index structure, and usage flow examples.
- Developed `brainy_architecture_visual.md` to complement the architecture with visual aids in Mermaid.js:
- Provided detailed flowcharts, mind maps, and sequence diagrams for system components and data flow.
- **Purpose**:
- Provide in-depth technical insights into Brainy's architecture for developers and stakeholders.
- Enhance understanding of the system's core design principles with easy-to-follow diagrams and examples.
This commit is contained in:
parent
672be32bea
commit
5f9e807952
10 changed files with 2842 additions and 2 deletions
|
|
@ -72,6 +72,7 @@
|
|||
"test:specialized": "vitest run tests/specialized-scenarios.test.ts",
|
||||
"test:performance": "vitest run tests/performance.test.ts",
|
||||
"test:comprehensive": "npm run test:error-handling && npm run test:edge-cases && npm run test:storage && npm run test:environments && npm run test:specialized",
|
||||
"_generate-pdf": "node dev/scripts/generate-architecture-pdf.js",
|
||||
"_release": "standard-version",
|
||||
"_release:patch": "standard-version --release-as patch",
|
||||
"_release:minor": "standard-version --release-as minor",
|
||||
|
|
@ -151,7 +152,7 @@
|
|||
"happy-dom": "^18.0.1",
|
||||
"jsdom": "^26.1.0",
|
||||
"node-fetch": "^3.3.2",
|
||||
"puppeteer": "^22.5.0",
|
||||
"puppeteer": "^22.15.0",
|
||||
"rollup": "^4.13.0",
|
||||
"rollup-plugin-terser": "^7.0.2",
|
||||
"standard-version": "^9.5.0",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue