Claude
250a5cb2a6
- UNAS layout decoded from the user's tree: services/<svc>/ is the homelab-wide docker config store (every container follows the same pattern — immich, karakeep, nextcloud, ntfy, paperless-ai, pocketid, shelfmark, stremio, traccar, vaultwarden, gluetun). Nexa MUST follow the same pattern at services/nexa/. backup/<svc>/ for snapshots. Pinned in CLAUDE.md and docs/12 #31. - Stale services flagged for retirement: services/siyuan/ (migrated to Obsidian) and services/open-webui/ (unused, only LobeHub is alive). Drops the "two LLM UIs" item (#15) — it's now "retire open-webui". - Hard-blocklist for any Nexa indexer pinned in CLAUDE.md: _sortMe/wallet/**, *.gpg/asc/key/pem/kdbx/credentials/secret, plus the Nextcloud appdata dir. - Three new "future user-facing wins" surfaced from the tree: Paperless-AI as a Phase-2.x triage helper for _sortMe/Downloads/, media/Recipes/ (~300 entries) as the showcase RAG corpus, and Paperless-AI's existing ChromaDB as a potential read-from source rather than re-embedding scanned docs. - Housekeeping campaign in docs/12 §35-37: consolidate postgres, audit UNAS-everywhere, S3 archive tier on s3.nuclide.systems. - Phase 6 added to the roadmap: "Nexa as homelab steward". Polls Dockge/docker/Proxmox, diffs vs documented state, emits a daily drift report. Most of the housekeeping campaign becomes semi-automatic once 6.1-6.3 ship. - New docs/13-information-wishlist.md packages the still-needed inventory as 5-6 paste-and-run tasks, each with explicit "📍 Where" markers (which shell or which UI) and what it unblocks. Highest leverage = Task 1 (read an existing compose stack to lock Q19). - docs/index.md TOC extended to 13 rows. Also fixed numbering drift in docs/12 (duplicate #28, missing #17/#18) and added Q19 to docs/11 covering the SMB-share verification step.
52 lines
2.6 KiB
Markdown
52 lines
2.6 KiB
Markdown
# 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](./01-vision-and-scope.md) | You want to understand *what* Nexa is and isn't. |
|
|
| 02 | [Roadmap & Phases](./02-roadmap.md) | You want to know the implementation order. |
|
|
| 03 | [Architecture Overview](./03-architecture.md) | You need a one-page mental model. |
|
|
| 04 | [Integration Matrix](./04-integration-matrix.md) | You're wiring up a new data source or mapping work-vs-personal flows. |
|
|
| 05 | [Command System](./05-command-system.md) | You want to know what `#nexa:*` commands do. |
|
|
| 06 | [Classification Logic](./06-classification-logic.md) | You're tuning the work/personal router. |
|
|
| 07 | [Workflow Spec — Task Router](./07-workflow-spec.md) | You're building the Phase-2 router workflow. |
|
|
| 08 | [GraphRAG Architecture](./08-graphrag-architecture.md) | You're working on Phase 3 (Qdrant + Graph). |
|
|
| 09 | [Deployment](./09-deployment.md) | You're bringing Nexa up on the real infrastructure. |
|
|
| 10 | [Operations](./10-operations.md) | You need backup, monitoring or troubleshooting. |
|
|
| 11 | [Open Questions (user-info-required)](./11-open-questions.md) | Items the user still has to answer before progress. |
|
|
| 12 | [Optimization Opportunities](./12-optimization-opportunities.md) | Ideas worth considering for the wider homelab. |
|
|
| 13 | [Information Wishlist](./13-information-wishlist.md) | What additional system inventory would sharpen future decisions. |
|
|
|
|
---
|
|
|
|
## 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/`.
|