Folder Structure
homelab-docs/
├── docs/
│ ├── README.md # Main navigation hub
│ ├── current-state.md # What's running right now
│ ├── QUICK-REFERENCE.md # IPs, URLs, common commands
│ ├── inventory.md # Hardware inventory (single source of truth)
│ ├── network.md # Network configuration
│ ├── services.md # Services overview
│ ├── architecture.md # Design goals and decisions
│ ├── CHANGELOG.md # All significant changes
│ ├── LESSONS-LEARNED.md # Mistakes and discoveries
│ ├── Folder_structure.md # This file
│ │
│ ├── servers/
│ │ ├── jc-pve01.md # Proxmox node 1 (192.168.4.21)
│ │ ├── jc-pve02.md # Proxmox node 2 (192.168.4.22)
│ │ ├── jc-pve03.md # Proxmox node 3 (192.168.4.23)
│ │ └── jc-pve04.md # Proxmox node 4 (192.168.4.24)
│ │
│ ├── services/
│ │ ├── uptime-kuma.md # Uptime monitoring
│ │ ├── grafana.md # Metrics dashboards
│ │ ├── prometheus.md # Metrics collection
│ │ ├── zabbix.md # Network/host monitoring
│ │ ├── jellyfin.md # Media server
│ │ ├── caddy.md # Reverse proxy
│ │ ├── tailscale.md # VPN / remote access
│ │ └── home-assistant/
│ │ ├── home_assistant.md # HA architecture overview
│ │ ├── ha_automations.md # Automation logic
│ │ ├── scripts.md # HA scripts
│ │ ├── integrations.md # Integrations and devices
│ │ ├── dashboards.md # Dashboard documentation
│ │ └── configs/
│ │ └── README.md # Config file index
│ │
│ ├── recovery/
│ │ ├── backups.md # Backup overview
│ │ ├── backup-strategy.md # Backup strategy details
│ │ ├── disaster-recovery.md # DR procedures
│ │ └── proxmox-backup-restore.md # Proxmox-specific restore steps
│ │
│ ├── procedures/
│ │ └── migration-plan.md # One-time migration procedures
│ │
│ ├── projects/
│ │ └── homelab-proxmox.md # Proxmox cluster project notes
│ │
│ └── templates/
│ ├── lesson-learned.md # Template for new lessons
│ └── service-template.md # Template for new service docs
│
├── mkdocs.yml # MkDocs site configuration
├── CLAUDE.md # Claude Code instructions
└── .setup-complete # Setup completion marker