47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
# Documentation
|
|
|
|
## Overview
|
|
|
|
This directory contains all technical documentation for the Castaldi Family Homelab infrastructure.
|
|
|
|
---
|
|
|
|
## Quick Reference
|
|
|
|
### 📘 Runbooks & Guides
|
|
|
|
- **[TECHNICAL_RUNBOOK.md](TECHNICAL_RUNBOOK.md)** - Complete infrastructure reference, emergency procedures, and maintenance schedule
|
|
- **[LLM_HANDOVER.md](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](KBA-001-Komodo-GitOps-Stack-Deployment-Failures.md)**
|
|
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:
|
|
|
|
1. **KBA Format:** Use for troubleshooting scenarios with clear problem/solution
|
|
2. **Update Runbook:** Add new emergency procedures to TECHNICAL_RUNBOOK.md
|
|
3. **Update Repository Memory:** Store critical lessons in `/memories/repo/`
|
|
4. **Commit Messages:** Use conventional commits (e.g., `docs: Add KBA-002 for...`)
|
|
|
|
---
|
|
|
|
**Last Updated:** April 12, 2026
|