24 lines
1.6 KiB
Markdown
24 lines
1.6 KiB
Markdown
|
# @platform/docs
|
||
|
|
|
||
|
|
Project-level docs for the V3 platform monorepo. Strategy and lineage live at the repo root (`../DESIGN.md`, `../INFRA.md`, `../CLAUDE.md`, `../README.md`); per-feature docs live next to the feature code under `codebase/@features/<name>/`. This directory is for cross-cutting reference material that doesn't belong to a single feature.
|
||
|
|
|
||
|
|
## Index
|
||
|
|
|
||
|
|
- **[tenancy.md](./tenancy.md)** — Person / Org / Client model, schema additions, JWT context switching, RLS policy stance
|
||
|
|
- **[naming.md](./naming.md)** — Quinn-specific → provider-generic renaming, deployed-domain rule, hostname taxonomy
|
||
|
|
- **[phase-5-gates.md](./phase-5-gates.md)** — Phase 5 (infrastructure foundation) verification gates with status; the wall before feature work can start
|
||
|
|
- **[onboarding-provider.md](./onboarding-provider.md)** — operational steps to onboard a new provider (merche biche worked example)
|
||
|
|
- **[peers.md](./peers.md)** — sibling services consumed over HTTP/MCP (mail-sync, mac-sync, @ml/*, @agents/*, @messenger) — what each exposes and how the platform reaches it
|
||
|
|
|
||
|
|
## What goes where
|
||
|
|
|
||
|
|
| Concern | Location |
|
||
|
|
|---------|----------|
|
||
|
|
| "Why V3 exists" / lineage / phases | `../DESIGN.md` |
|
||
|
|
| Host roles, networking, DB layout, backups | `../INFRA.md` |
|
||
|
|
| Agent rules, hard "do not" list | `../CLAUDE.md` |
|
||
|
|
| Cross-cutting platform reference (this dir) | `@platform/docs/` |
|
||
|
|
| Feature design notes, API contracts | `codebase/@features/<name>/docs/` or `codebase/@features/<name>/README.md` |
|
||
|
|
| Deploy runbook for a specific domain | `deployments/@domains/<domain>/README.md` |
|
||
|
|
| Long-form business / brand / strategy | `../business/` (non-code) |
|