Skip to content

docs: add ARCHITECTURE.md for offline-first AI system design#42

Open
upendra512 wants to merge 1 commit into
AOSSIE-Org:mainfrom
upendra512:docs/offline-first-ai-architecture
Open

docs: add ARCHITECTURE.md for offline-first AI system design#42
upendra512 wants to merge 1 commit into
AOSSIE-Org:mainfrom
upendra512:docs/offline-first-ai-architecture

Conversation

@upendra512
Copy link
Copy Markdown

Closes #17

Adds ARCHITECTURE.md documenting the offline-first AI system design for SmartNotes.

Contents:

  • Core design principles (offline by default, privacy-first, single-process storage)
  • System layers diagram: Electron main/renderer, Web Worker, Ollama daemon
  • TypeScript interfaces for all five modules: VaultStorage, EmbeddingWorker, HybridRetriever, RAGEngine, LinkStore
  • SQLite schema for notes, FTS5 index, and sqlite-vec embeddings
  • Three end-to-end data flow diagrams: note save, semantic search, Q&A
  • Performance targets per operation
  • Graceful degradation table showing what works without Ollama
  • Planned file structure

Checklist:

  • Self-review completed
  • Documentation updated

…Org#17)

Addresses issue AOSSIE-Org#17: document the offline-first AI architecture and
modular retrieval design for SmartNotes.

The document covers:
- Core design principles (offline by default, privacy-first, single-process storage)
- System layers diagram: Electron main/renderer, Web Worker, Ollama daemon
- Module contracts with TypeScript interfaces for all five subsystems:
  VaultStorage (SQLite CRUD), EmbeddingWorker (Transformers.js WASM),
  HybridRetriever (BM25 + cosine + RRF), RAGEngine (Ollama streaming),
  LinkStore (explicit + auto-suggested links)
- SQLite schema for notes, FTS5 index, and sqlite-vec embeddings table
- Three end-to-end data flow diagrams: note save, semantic search, Q&A
- Performance targets per operation (embedding, search, graph, RAG)
- Graceful degradation table showing what works without Ollama
- Planned file structure for main/renderer/shared modules

Fixes AOSSIE-Org#17

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 12, 2026

Warning

Rate limit exceeded

@upendra512 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 29 minutes and 30 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 29 minutes and 30 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: a1e421e0-3fc3-4860-ae6d-d2c55df1a251

📥 Commits

Reviewing files that changed from the base of the PR and between 4bb58bd and ed68dfa.

📒 Files selected for processing (1)
  • ARCHITECTURE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added enhancement New feature or request documentation Improvements or additions to documentation size/L first-time-contributor labels Apr 12, 2026
@github-actions
Copy link
Copy Markdown

This pull request has been automatically marked as stale due to inactivity. It will be closed if no further activity occurs within 7 days.

@github-actions github-actions Bot added the stale label May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request first-time-contributor size/L stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE]: Document offline‑first AI architecture and modular retrieval design for SmartNotes

2 participants