Ty
69b67498ff
Replace stale scaffold-only status with install progress, actor split, and design vs docs vs skills maps so operators can follow the product narrative.
38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
# Operator & user documentation
|
||
|
||
Runbooks and how-tos. **Product design SSOT** is under [`../design/`](../design/).
|
||
|
||
| Location | Purpose |
|
||
|----------|---------|
|
||
| `design/` | Why and what — architecture, use cases, scenarios, decisions |
|
||
| `docs/` | How-to — install, upgrade, operations, providers, policy |
|
||
|
||
---
|
||
|
||
## Document status
|
||
|
||
| Document | Purpose | Status |
|
||
|----------|---------|--------|
|
||
| [DEPLOYER_HOST.md](DEPLOYER_HOST.md) | Create/baseline host requirements | ✅ Procedural — ready for operator use |
|
||
| [INSTALL.md](INSTALL.md) | Install stages S0–S6 | ✅ Implemented |
|
||
| [HERMES_MODELS.md](HERMES_MODELS.md) | Main + auxiliary models | ✅ S2-ready |
|
||
| [OPERATIONS.md](OPERATIONS.md) | Day-2 logs, doctor | ✅ Doctor (S6) implemented |
|
||
| [POLICY.md](POLICY.md) | OpenShell policy apply | Outline (POR) |
|
||
| [SETUP_UX.md](SETUP_UX.md) | Owner educational connect flows | Outline (POR) |
|
||
| [UPGRADE.md](UPGRADE.md) | Upgrade / rollback | Outline — full design in [design/updates-lifecycle.md](../design/updates-lifecycle.md) |
|
||
| [ARCHITECTURE.md](ARCHITECTURE.md) | Operator-facing architecture summary | Outline → links design |
|
||
| [providers/](providers/) | Square, QBO, Vagaro, channels | Outlines |
|
||
|
||
---
|
||
|
||
## What's done vs planned
|
||
|
||
**Done (scripts implemented, callable via `make`):**
|
||
- S0b: Docker bootstrap (`make bootstrap`)
|
||
- S1–S5: Full install (`make install`)
|
||
- S6: Doctor health checks (`make doctor`)
|
||
|
||
**Pending:**
|
||
- S7: Owner connect + operator connect helpers (`connect/*.sh`)
|
||
- Upgrade: `upgrade.sh` (snapshot, pull, migrate, re-apply policy, doctor)
|