structure: sync docs/README.md

This commit is contained in:
Ty
2026-07-27 16:09:09 +00:00
parent c03bf07e9f
commit 8a08b9b3bd
+14 -9
View File
@@ -1,12 +1,17 @@
# Documentation index
# Operator & user documentation
| Document | Purpose |
|----------|---------|
| [DESIGN_PLAN.md](DESIGN_PLAN.md) | Approved architecture + implementation plan |
| [../design/use-cases.md](../design/use-cases.md) | Use-case catalog (SSOT) |
| [../design/scenarios.md](../design/scenarios.md) | Narrative scenarios |
| [../design/DECISIONS.md](../design/DECISIONS.md) | Resolved decisions |
Runbooks and how-tos. **Product design SSOT** is under [`../design/`](../design/).
## Planned at build time (not yet written)
| Document | Purpose | Status |
|----------|---------|--------|
| [DEPLOYER_HOST.md](DEPLOYER_HOST.md) | Create/baselined host requirements | Outline (POR) |
| [INSTALL.md](INSTALL.md) | Install stages S0S6 | Outline (POR) |
| [UPGRADE.md](UPGRADE.md) | Upgrade / rollback | Outline — full design in [design/updates-lifecycle.md](../design/updates-lifecycle.md) |
| [HERMES_MODELS.md](HERMES_MODELS.md) | Main + auxiliary models | Outline (POR) |
| [ARCHITECTURE.md](ARCHITECTURE.md) | Operator-facing architecture summary | Outline → links design |
| [POLICY.md](POLICY.md) | OpenShell policy apply | Outline (POR) |
| [SETUP_UX.md](SETUP_UX.md) | Owner educational connect flows | Outline (POR) |
| [OPERATIONS.md](OPERATIONS.md) | Day-2 logs, doctor | Outline (POR) |
| [providers/](providers/) | Square, QBO, Vagaro, channels | Outlines |
Per design plan workstreams: `DEPLOYER_HOST.md`, `INSTALL.md`, `UPGRADE.md`, `HERMES_MODELS.md`, `ARCHITECTURE.md`, `POLICY.md`, `SETUP_UX.md`, provider/MCP operator guides.
Implementation of install scripts is **not** started until **build**.