mrcharles
6b6a8ff021
Split docs/ into project-based subdirectories:
- docs/proxmox/ fleet ops, hardware, k8s (PROJECT.md, TODO.md, K8S.md)
- docs/server-build/ provisioning, security, DNS (SECURITY.md, tailscale.md,
DEPLOYMENT.md, TSYS-2FA-GUIDE.md, DEVELOPMENT-GUIDELINES.md)
- docs/archive/ historical AI reviews, completed todos, pre-refactor docs
docmap.md rewritten with new paths. All cross-references in AGENTS.md,
README.md, STATUS.md, and dns-cluster-setup/README.md updated.
Code directories unchanged — scripts stay where BASH_SOURCE expects them.
🤖 Generated with [Crush](https://github.com/charmassociates/crush)
Assisted-by: GLM-5 via Crush <crush@charm.land>
4.5 KiB
4.5 KiB
Documentation Map
Index of all documentation in this repo. Agents must update this file whenever a doc is added, removed, or substantively changed.
Last updated: 2026-07-28
Proxmox Cluster (proxmox/)
Fleet operations, hardware, performance tuning, storage architecture.
| Document | Description | Last Reviewed |
|---|---|---|
proxmox/PROJECT.md |
Comprehensive fleet report: 7 hosts, VM inventory, storage, recommendations | 2026-07-27 |
proxmox/TODO.md |
Pending physical hardware work (tsys2/4/5 Friday plan) | 2026-07-27 |
proxmox/K8S.md |
Kubernetes architecture deep-dive (for future k8s session) | 2026-07-27 |
Server Build (server-build/)
Server provisioning, security hardening, DNS/NTP configuration.
| Document | Description | Last Reviewed |
|---|---|---|
server-build/SECURITY.md |
Security architecture: SSH hardening, 2FA, SCAP-STIG, Wazuh, auditd | 2026-07-25 |
server-build/tailscale.md |
Tailscale vs managed DNS analysis (RESOLVED — netinfra pair serves knel.net) | 2026-07-28 |
server-build/DEPLOYMENT.md |
Server deployment procedures, package lists, config flow | 2026-07-25 |
server-build/TSYS-2FA-GUIDE.md |
End-user guide for 2FA setup (SSH, Cockpit, Webmin) | 2026-07-25 |
server-build/DEVELOPMENT-GUIDELINES.md |
Coding standards, commit conventions, script patterns | 2026-07-25 |
Operational Guides (outside docs/)
| Document | Description | Last Reviewed |
|---|---|---|
../dns-cluster-setup/README.md |
Technitium DNS cluster setup: export, deploy, cluster, verify | 2026-07-28 |
../tests/README.md |
Test suite documentation: unit, security, validation tests | 2026-07-28 |
../netinfra/pfv-netinfra-setup.md |
pfv-netinfra-01/02 initial setup guide | 2026-07-27 |
../netinfra/pfv-netboot-setup.md |
pfv-netboot reference node setup | 2026-07-27 |
Archive (archive/)
Historical AI reviews, completed task lists, and pre-refactor examples. Read-only context — do not update; link to active docs instead.
| Document | Description |
|---|---|
archive/CODE-REVIEW-FINDINGS.md |
Early code review findings (most issues now fixed) |
archive/REFACTORING-EXAMPLES.md |
Pre-refactor code patterns (historical "before" examples) |
archive/Claude-Review.md |
Claude's initial code review |
archive/AIReview-QWEN.md |
Qwen AI review |
archive/AiOverview-Gemini.md |
Gemini project overview |
archive/AiOverview-OpenCode.md |
OpenCode project overview |
archive/AiSecurityAudit-Gemini.md |
Gemini security audit |
archive/charles-todo.md |
Charles's early task list (completed) |
archive/claude-todo.md |
Claude's early task list (completed) |
Top-Level Files
| File | Description |
|---|---|
../AGENTS.md |
Agent operating instructions (repo layout, git policy, gardening protocol) |
../STATUS.md |
Living project status (agent-maintained, human read-only) |
../README.md |
Project overview and quick start |
../LICENSE |
License |
Agent Gardening Protocol
When making changes to this repo, agents MUST:
- Update
../STATUS.mdif the work changes infrastructure state, completes/starts a task, or discovers a new issue. - Update this file (
docmap.md) if a doc is added, removed, or has a substantive content change. Update the "Last Reviewed" date. - Verify cross-references — any new
.mdfile must be linked from at least one existing doc or this map. - Check for stale paths — after any directory rename or file move,
grep -rn 'old/path' --include='*.md'and fix all references. - Keep code and docs in sync — if you change a script's interface, behavior, or location, update every doc that references it in the same commit.