Ty_Tech/Salon_Assistant
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document project strategy and flow in READMEs.

Browse Source 
Replace stale scaffold-only status with install progress, actor split, and design vs docs vs skills maps so operators can follow the product narrative.
This commit is contained in:
Ty
2026-07-27 12:51:07 -07:00
parent 15f6a6c713
commit 69b67498ff
5 changed files with 258 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ARCHITECTURE.md
+4
View File
@@ -12,6 +12,10 @@ Host (bootstrap, Docker, product scripts, nemohermes/openshell CLIs)
→ External OpenAI-compatible model (outside containers OK)
```
## How it flows
For the end-to-end narrative (design → implement → install → runtime → owner chat), see the **[root README](../README.md)** section "How the project flows."
## Related design docs
- [Planes](../design/planes.md)
docs/README.md
+27 -7
View File
@@ -2,16 +2,36 @@
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/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 |
| [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) |
| [OPERATIONS.md](OPERATIONS.md) | Day-2 logs, doctor | 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 |
Implementation of install scripts is **not** started until **build**.
---
## 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)