1.4 KiB
1.4 KiB
Documentation
Overview
This directory contains all technical documentation for the Castaldi Family Homelab infrastructure.
Quick Reference
📘 Runbooks & Guides
- TECHNICAL_RUNBOOK.md - Complete infrastructure reference, emergency procedures, and maintenance schedule
- LLM_HANDOVER.md - Quick-start context document for AI-assisted troubleshooting sessions
Knowledge Base Articles (KBA)
GitOps & Deployment
- KBA-001: Komodo GitOps Stack Deployment Failures
Troubleshooting guide for Git-linked stack pull/deploy failures, canonicalize errors, and Docker image tag issues.
Document Conventions
- KBA-XXX: Structured troubleshooting articles following the incident → resolution format
- Runbooks: Procedural guides for operations and emergency response
- Handover Documents: Context summaries for knowledge transfer
Contributing
When documenting new issues or procedures:
- KBA Format: Use for troubleshooting scenarios with clear problem/solution
- Update Runbook: Add new emergency procedures to TECHNICAL_RUNBOOK.md
- Update Repository Memory: Store critical lessons in
/memories/repo/ - Commit Messages: Use conventional commits (e.g.,
docs: Add KBA-002 for...)
Last Updated: April 12, 2026