vh
58fcb04ce4
Second pass on docs/ cleanup (item #15 in STATUS.md): - pfi/chromadb-setup.md: deleted. References configs/pfi-ana/... and scripts/setup-chromadb.sh, neither of which exist in this repo (artifacts of an earlier project layout). ChromaDB is already live per docker-stack.md; the operational truth lives there. - pfi/docker-stack.md: removed the cross-link to the deleted file and pulled the bit of useful content from it (auth-token generation + client Settings example) into the inline ChromaDB section. - pfi/vm-102-matrix-{synapse,appservice}.md: stripped the YAML frontmatter. The `path:` values pointed at docs/pfi-ana/... which doesn't exist in this repo; no toolchain consumed the metadata. - README.md: tree updated to reflect the deletion. VM-102 docs kept separate by design — each is right-sized; merging would push past the ~500-line guideline.
53 lines
2.1 KiB
Markdown
53 lines
2.1 KiB
Markdown
# docs/
|
|
|
|
Navigation map for the documentation tree. New session? Read
|
|
[`orientation.md`](orientation.md) first — it's the narrative overview
|
|
of the fleet, backup architecture, governing principles, and gotchas,
|
|
and it points at everything else.
|
|
|
|
## Tree
|
|
|
|
```
|
|
docs/
|
|
├── orientation.md # start here — fleet overview + where-to-look guide
|
|
├── runbooks/ # ops runbooks (recovery, deployment phases)
|
|
│ ├── disaster-recovery.md
|
|
│ └── pbs-deployment.md
|
|
└── pfi/ # PFI-specific reference (services, models, VMs)
|
|
├── docker-stack.md
|
|
├── model-list.md
|
|
├── proxmox-vms.md
|
|
├── recommended-model-settings.md
|
|
├── vm-102-matrix-appservice.md
|
|
└── vm-102-matrix-synapse.md
|
|
```
|
|
|
|
## What goes where
|
|
|
|
- **`runbooks/`** — step-by-step ops procedures. Anything you'd reach
|
|
for during an incident or while standing up new infrastructure.
|
|
Examples: disaster recovery (blast-radius tiers + restoration steps),
|
|
PBS deployment (9-phase rollout). New runbook → new file here.
|
|
- **`pfi/`** — PFI-specific reference material that's too narrow for the
|
|
top-level CLAUDE.md but doesn't change incident response. AI model
|
|
inventory, recommended inference settings, Matrix bridge config,
|
|
Proxmox VM map. New stable reference → new file here.
|
|
- **Top-level (`docs/orientation.md`, `docs/README.md`)** — narrative
|
|
guides about the workspace itself, not about specific infra.
|
|
|
|
## Cross-references
|
|
|
|
- Fleet topology + servers table: top-level [`CLAUDE.md`](../CLAUDE.md).
|
|
- Open work + recent milestones: top-level [`STATUS.md`](../STATUS.md).
|
|
- Durable cross-session facts: `~/.claude/projects/-home-lkraven-development-eshpfi-management/memory/`.
|
|
|
|
## Conventions
|
|
|
|
- Markdown, GitHub-flavored. CommonMark renders fine in most viewers.
|
|
- File names are lowercase-kebab-case, descriptive. No dates in
|
|
filenames — git history covers that.
|
|
- One topic per file. If a file grows past ~500 lines, look for a
|
|
natural split before adding more.
|
|
- No checked-in binaries or checksums. Build/release artifacts belong
|
|
in a build pipeline or `tools/`, not `docs/`.
|