docs: refresh root README for approved design/ structure
This commit is contained in:
@@ -8,10 +8,11 @@ This directory is the **product seed** for the Gitea repository `Ty_Tech/Salon_A
|
||||
|
||||
| Artifact | Location |
|
||||
|----------|----------|
|
||||
| Approved design plan | [`docs/DESIGN_PLAN.md`](docs/DESIGN_PLAN.md) |
|
||||
| Design plan (SSOT) | [`design/DESIGN_PLAN.md`](design/DESIGN_PLAN.md) |
|
||||
| Use cases (SSOT) | [`design/use-cases.md`](design/use-cases.md) |
|
||||
| Scenarios | [`design/scenarios.md`](design/scenarios.md) |
|
||||
| Resolved decisions | [`design/DECISIONS.md`](design/DECISIONS.md) |
|
||||
| Operator runbooks | [`docs/`](docs/) |
|
||||
| Implementation | **Not started** until explicit **build** / **implement** |
|
||||
|
||||
## Product planes
|
||||
@@ -25,11 +26,22 @@ This directory is the **product seed** for the Gitea repository `Ty_Tech/Salon_A
|
||||
| Social craft | Owner photos/video + vision aux |
|
||||
| Setup / ops | Install, connect SaaS, automatic updates (on by default) |
|
||||
|
||||
## Doc placement
|
||||
|
||||
| Folder | Purpose |
|
||||
|--------|---------|
|
||||
| **`design/`** | Product design SSOT — plan, use cases, scenarios, decisions, MCP strategy, update lifecycle |
|
||||
| **`docs/`** | Operator/user manuals — install, upgrade, providers, ops |
|
||||
|
||||
## Platform-first rule
|
||||
|
||||
All sandbox, policy, credential, channel, and inference mutations go through **`nemohermes` / `openshell`**. Product scripts wrap those CLIs. No parallel control API.
|
||||
All sandbox, policy, credential, channel, and inference mutations go through **`nemohermes` / `openshell`**. Product scripts (when built) wrap those CLIs. No parallel control API.
|
||||
|
||||
## Layout (scaffolds)
|
||||
|
||||
Code under `skills/`, `scripts/`, `services/`, `policy/`, etc. is **scaffold only** until **build**. See each area’s `README.md`.
|
||||
|
||||
## Remote
|
||||
|
||||
- Gitea: `Ty_Tech/Salon_Assistant` (public)
|
||||
- MCP for ops: `gitea_vps` → `https://giteamcp1.vps1.afterthedemo.com/mcp`
|
||||
- Git MCP for this product: **`gitea_vps`** only
|
||||
|
||||
Reference in New Issue
Block a user