David Snelling 5f9e807952 **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.

2025-08-02 16:05:48 -07:00

1.8 KiB

Raw Blame History

Quick PDF Generation Setup

🚀 Generate Professional Brainy Architecture PDF

One-Command Setup & Generation

# Install Puppeteer and generate PDF in one go
npm install puppeteer && npm run generate-pdf

Step-by-Step

Install Puppeteer (if not already installed):
```
npm install puppeteer
```
Generate the PDF:
```
npm run generate-pdf
```

Find your PDF:

docs/Brainy_Architecture_Documentation.pdf

✨ What You Get

25-30 page professional PDF with full diagrams
Vector graphics for all Mermaid diagrams
Modern typography with Inter font family
Consistent branding throughout the document
Table of contents with page links
Professional headers/footers

📊 Sample Sections Include

System Overview with environment detection
Core Architecture layers
Data Model (23 Noun Types, 38 Verb Types)
Vector Search Engine with HNSW visualization
Storage Architecture with multi-tier caching
Augmentation Pipeline flows
Performance optimizations
Cross-platform integration patterns
Real data flow examples

🛠️ Troubleshooting

Issue: "Puppeteer not found"

npm install puppeteer

Issue: "Chrome not found"

# Let Puppeteer download Chromium
npm install puppeteer --unsafe-perm=true

Issue: "Permission denied"

chmod +x dev/scripts/generate-architecture-pdf.js

🎨 Customization

Edit dev/scripts/generate-architecture-pdf.js to:

Change colors and fonts
Modify page layout
Adjust diagram styling
Add custom branding

Ready to generate? Run npm run generate-pdf and get your professional architecture documentation!

For detailed setup instructions, see PDF_GENERATION_GUIDE.md.

1.8 KiB Raw Blame History