Skip to main content

Documentation

Graduated documentation from brainstorming sessions, troubleshooting investigations, and project work.

Structure

docs/
├── gitops/            # GitOps consolidation, roadmaps, workflows, and drift management
├── platform/          # Platform architecture and operator models
├── homelab/           # Homelab planning (see homelab/README.md for topic index)
│   ├── overview/      # Map + visual graphic
│   ├── network/       # Tailscale, UniFi
│   ├── platform/      # Architecture, environments, hardware, repo layout
│   ├── observability/ # Public status + operator dashboard plans
│   ├── planning/      # Decisions, roadmap, scratchpad
│   └── iot/           # Smart home
├── troubleshooting/   # Remediation guides (from Troubleshoot sessions)
├── guides/            # Setup and prevention guides
│   ├── openshift/     # OpenShift / OCP how-tos (registry, GPU Operator, etc.)
│   └── dev-environment/ # VSCode setup, local tools, etc.
└── notes/             # Personal notes (events, etc.)

How Documentation Gets Here

Documentation graduates from wip/ sessions:

  1. Storm Sessions → Project documentation (e.g., docs/homelab/)
  2. Troubleshoot Sessions → Remediation docs (docs/troubleshooting/) and guides (docs/guides/)
  3. Reusable automation templates & AI execution plans → Graduate from wip/ to artifacts/ (for example Ansible/OpenShift patterns, manifests, and prompt-as-a-plan templates) with documentation alongside the templates

See workstyle/working_style.md for the full graduation workflow.

Current Projects

ProjectDescriptionStatus
HomelabInfrastructure architecture for greenfield homelab rebuildArchitecture complete
GitOps ConsolidationStrategic roadmap for returning clusters to trunk version control with taggingCompleted
OpenShift readiness (Ansible)Multi-play validation pattern, role skeleton, example roles; long-form authoring guide in-repoGraduated from wip/