Claude
9b18e2710d
- /docs/ now contains 12 numbered guides + index.md (navigator).
- Old duplicates removed: nexa-core/doc/, DEPLOYMENT.md, PLAN.md,
config/{classification_logic,workflows_spec}.md.
- 09-deployment.md targets the running infra (LXC 104 docker host,
Zoraxy at 192.168.1.4, existing Memos/n8n/LiteLLM/Nextcloud/Qdrant)
rather than spinning a parallel stack; minimal-config approach.
- 11-open-questions.md tracks user-info-required blockers.
- 12-optimization-opportunities.md captures homelab tweaks.
- CLAUDE.md added so future agent runs know repo conventions and infra.
2.4 KiB
2.4 KiB
NEXA Documentation
Neural Nexus for Information & Automation — the central nervous system that ties Memos, n8n, SAIA (LiteLLM), Nextcloud and a vector store into one assistant.
This is the documentation entry point. Read top-to-bottom for first-time setup, or jump to the section you need.
Table of Contents
| # | Document | Read when… |
|---|---|---|
| 01 | Vision & Scope | You want to understand what Nexa is and isn't. |
| 02 | Roadmap & Phases | You want to know the implementation order. |
| 03 | Architecture Overview | You need a one-page mental model. |
| 04 | Integration Matrix | You're wiring up a new data source or mapping work-vs-personal flows. |
| 05 | Command System | You want to know what #nexa:* commands do. |
| 06 | Classification Logic | You're tuning the work/personal router. |
| 07 | Workflow Spec — Task Router | You're building the Phase-2 router workflow. |
| 08 | GraphRAG Architecture | You're working on Phase 3 (Qdrant + Graph). |
| 09 | Deployment | You're bringing Nexa up on the real infrastructure. |
| 10 | Operations | You need backup, monitoring or troubleshooting. |
| 11 | Open Questions (user-info-required) | Items the user still has to answer before progress. |
| 12 | Optimization Opportunities | Ideas worth considering for the wider homelab. |
Reading paths
- First-time installer: 01 → 03 → 09 → 10 → 11
- Workflow author: 04 → 05 → 07 → 06
- Phase-3 work (memory): 08 → 09 (§ Phase 3 add-on)
- Stakeholder / quick read: 01 → 02 → 12
Repository layout
nexa/
├── README.md → points here
├── docs/ → you are here
└── nexa-core/ → the actual project
├── ai-prompts/ → SAIA system prompts
├── config/ → runtime config (YAML, JSON schema)
├── n8n-workflows/ → exported workflows, version-controlled
└── scripts/ → automation helpers
Source-of-truth for runnable config stays in nexa-core/. Documentation lives here in docs/.