From 8a08b9b3bd6722c19e0622bf0cc91a75db499572 Mon Sep 17 00:00:00 2001 From: Ty Date: Mon, 27 Jul 2026 16:09:09 +0000 Subject: [PATCH] structure: sync docs/README.md --- docs/README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2cc29b8..3a2f0d8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 S0–S6 | 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**.