Add engineering architecture docs
This commit is contained in:
20
README.md
20
README.md
@@ -38,13 +38,13 @@ python scripts/ingest_folder.py --path /path/to/notes
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
```text
|
||||
FastAPI (port 8100)
|
||||
├── Ingestion: markdown → parse → chunk → embed → store
|
||||
├── Retrieval: query → embed → vector search → rank
|
||||
├── Context Builder: retrieve → boost → budget → format
|
||||
├── SQLite (documents, chunks, memories, projects, interactions)
|
||||
└── ChromaDB (vector embeddings)
|
||||
|- Ingestion: markdown -> parse -> chunk -> embed -> store
|
||||
|- Retrieval: query -> embed -> vector search -> rank
|
||||
|- Context Builder: retrieve -> boost -> budget -> format
|
||||
|- SQLite (documents, chunks, memories, projects, interactions)
|
||||
'- ChromaDB (vector embeddings)
|
||||
```
|
||||
|
||||
## Configuration
|
||||
@@ -65,3 +65,11 @@ Set via environment variables (prefix `ATOCORE_`):
|
||||
pip install -e ".[dev]"
|
||||
pytest
|
||||
```
|
||||
|
||||
## Architecture Notes
|
||||
|
||||
Implementation-facing architecture notes live under `docs/architecture/`.
|
||||
|
||||
Current additions:
|
||||
- `docs/architecture/engineering-knowledge-hybrid-architecture.md`
|
||||
- `docs/architecture/engineering-ontology-v1.md`
|
||||
|
||||
Reference in New Issue
Block a user