From b16ac8cf0cd006b6c67b46a4b89243a37eb98245 Mon Sep 17 00:00:00 2001 From: nathan Date: Sat, 11 Apr 2026 23:35:17 -0400 Subject: [PATCH] docs: Create documentation index with KBA reference --- documentation/README.md | 47 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/documentation/README.md b/documentation/README.md index bb8fe05..d704fb0 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1 +1,46 @@ -# documenation folder +# 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