# 📚 Homelab Documentation Index

*Complete navigation guide for Vish's Homelab documentation*

## 🎯 Quick Navigation

### 🚀 Getting Started
- [**README.md**](../README.md) - Main repository overview and quick start
- [**What is a Homelab?**](getting-started/what-is-homelab.md) - Introduction to homelabs
- [**Beginner Quickstart**](getting-started/BEGINNER_QUICKSTART.md) - Step-by-step setup guide
- [**Prerequisites**](getting-started/prerequisites.md) - Required knowledge and tools
- [**Shopping Guide**](getting-started/shopping-guide.md) - Hardware recommendations

### 🏗️ GitOps Deployment (Primary Method)
- [**Deploy a New Service — End-to-End**](guides/deploy-new-service-gitops.md) - ⭐ **START HERE: compose file → Portainer → auto-deploy**
- [**GitOps Comprehensive Guide**](admin/GITOPS_COMPREHENSIVE_GUIDE.md) - Full GitOps architecture reference
- [**GitOps Deployment Guide**](../GITOPS_DEPLOYMENT_GUIDE.md) - Dashboard fixes and procedures
- [**Deployment Workflow**](admin/DEPLOYMENT_WORKFLOW.md) - Step-by-step deployment process

### 🖥️ Infrastructure & Architecture
- [**Infrastructure Overview**](infrastructure/INFRASTRUCTURE_OVERVIEW.md) - Complete infrastructure documentation
- [**Infrastructure Health Report**](infrastructure/INFRASTRUCTURE_HEALTH_REPORT.md) - Current system status
- [**Hardware Inventory**](infrastructure/hardware-inventory.md) - Complete hardware documentation
- [**Network Topology**](diagrams/network-topology.md) - Network architecture diagrams
- [**Service Architecture**](diagrams/service-architecture.md) - Service deployment architecture

### 🔧 Administration & Operations
- [**Current Infrastructure Status**](admin/CURRENT_INFRASTRUCTURE_STATUS.md) - ⭐ **LATEST STATUS REPORT**
- [**Operational Status**](../OPERATIONAL_STATUS.md) - Historical deployment status
- [**DokuWiki Integration**](admin/DOKUWIKI_INTEGRATION.md) - Documentation mirroring to DokuWiki ✅
- [**Gitea Wiki Integration**](admin/GITEA_WIKI_INTEGRATION.md) - Native wiki integration 🔄
- [**Portainer API Guide**](admin/PORTAINER_API_GUIDE.md) - Container management via API ⭐
- [**Documentation Maintenance Guide**](admin/DOCUMENTATION_MAINTENANCE_GUIDE.md) - Keep docs synchronized ⭐
- [**Monitoring Setup**](admin/monitoring-setup.md) - Monitoring and alerting configuration
- [**Backup Strategies**](admin/backup-strategies.md) - Backup and disaster recovery
- [**Maintenance Procedures**](admin/maintenance.md) - Regular maintenance tasks
- [**Security Hardening**](security/SERVER_HARDENING.md) - Security configuration guide

### 📊 Monitoring & Observability
- [**Monitoring Architecture**](../MONITORING_ARCHITECTURE.md) - Complete monitoring stack documentation
- [**Dashboard Setup**](services/DASHBOARD_SETUP.md) - Grafana dashboard configuration
- [**Watchtower Deployment Fixes**](WATCHTOWER_DEPLOYMENT_FIXES.md) - Auto-update system

### 🛠️ Service Management
- [**Verified Service Inventory**](services/VERIFIED_SERVICE_INVENTORY.md) - Complete service catalog
- [**Service Categories**](services/categories.md) - Services organized by function
- [**Popular Services**](services/popular.md) - Most commonly used services
- [**Service Dependencies**](services/dependencies.md) - Service relationship mapping

### 🔐 Security Documentation
- [**Security Overview**](infrastructure/security.md) - Security architecture
- [**SSH Access Guide**](infrastructure/SSH_ACCESS_GUIDE.md) - Secure access procedures
- [**User Access Guide**](infrastructure/USER_ACCESS_GUIDE.md) - User management and access
- [**Repository Sanitization**](admin/REPOSITORY_SANITIZATION.md) - Public mirror documentation

### 🏠 Host-Specific Documentation

#### Synology NAS Systems
- [**Atlantis Storage**](hardware/atlantis-storage.md) - Primary NAS configuration
- [**Synology SSH Access**](admin/synology-ssh-access.md) - SSH setup for Synology
- [**Synology DSM Upgrade**](runbooks/synology-dsm-upgrade.md) - DSM upgrade procedures

#### Virtual Machines & Edge Devices
- [**Proxmox Setup**](infrastructure/hosts.md) - VM host configuration
- [**Raspberry Pi Setup**](infrastructure/hosts.md) - Edge device configuration

### 🌐 Network & Connectivity
- [**Tailscale Setup Guide**](infrastructure/tailscale-setup-guide.md) - VPN mesh network
- [**Cloudflare Tunnels**](infrastructure/cloudflare-tunnels-setup.md) - External access setup
- [**Port Forwarding Guide**](infrastructure/port-forwarding-guide.md) - Network configuration
- [**Network Performance Tuning**](infrastructure/network-performance-tuning.md) - Optimization guide

### 🎮 Gaming & Entertainment
- [**Gaming Server Documentation**](OPERATIONAL_STATUS.md#gaming-services) - Minecraft, Garry's Mod setup
- [**Fluxer Setup**](services/individual/fluxer.md) - Self-hosted chat platform (st.vish.gg)
- [**Media Services**](services/categories.md#media--entertainment) - Plex, Jellyfin, *arr stack

### 🔄 Advanced Topics
- [**Homelab Maturity Roadmap**](advanced/HOMELAB_MATURITY_ROADMAP.md) - Infrastructure evolution
- [**Terraform Implementation**](advanced/TERRAFORM_IMPLEMENTATION_GUIDE.md) - Infrastructure as Code
- [**Kubernetes Setup**](infrastructure/kubernetes-cluster-setup.md) - Container orchestration
- [**Scaling Guide**](advanced/scaling.md) - Infrastructure scaling strategies

## 📊 Documentation Status

### ✅ Up-to-Date Documentation
- GitOps deployment procedures
- Infrastructure health reports
- Service inventory and status
- Security hardening guides
- Monitoring and alerting setup

### 🔄 Recently Updated
- GitOps comprehensive guide (Feb 14, 2026)
- Infrastructure health report (Feb 8, 2026)
- Operational status (Feb 11, 2026)
- Watchtower deployment fixes (Feb 13, 2026)

### 📝 Documentation Standards
- **Status Indicators**: ✅ Active, 🔄 Updated, 🚧 In Progress, ⚠️ Needs Update
- **Review Cycle**: Monthly review for critical docs, quarterly for others
- **Version Control**: All documentation changes tracked in Git
- **Cross-References**: Links validated and updated regularly

## 🎯 Quick Reference by Use Case

### "I want to deploy a new service"
1. [Deploy a New Service — End-to-End](guides/deploy-new-service-gitops.md) - Complete walkthrough from compose file to live container
2. [Add New Service Runbook](runbooks/add-new-service.md) - Extended checklist (monitoring, backups, SSO)

### "Something is broken"
1. [Common Issues](troubleshooting/common-issues.md) - Quick fixes
2. [Emergency Access Guide](troubleshooting/EMERGENCY_ACCESS_GUIDE.md) - Emergency procedures
3. [Container Diagnosis](troubleshooting/CONTAINER_DIAGNOSIS_REPORT.md) - Container troubleshooting

### "I need to understand the infrastructure"
1. [Infrastructure Overview](infrastructure/INFRASTRUCTURE_OVERVIEW.md) - Complete overview
2. [Network Topology](diagrams/network-topology.md) - Network architecture
3. [Service Architecture](diagrams/service-architecture.md) - Service layout

### "I'm new to homelabs"
1. [What is a Homelab?](getting-started/what-is-homelab.md) - Introduction
2. [Beginner Quickstart](getting-started/BEGINNER_QUICKSTART.md) - Getting started
3. [Shopping Guide](getting-started/shopping-guide.md) - Hardware recommendations

### "I need to perform maintenance"
1. [Maintenance Procedures](admin/maintenance.md) - Regular maintenance
2. [Backup Strategies](admin/backup-strategies.md) - Backup procedures
3. [Security Hardening](security/SERVER_HARDENING.md) - Security updates

## 📞 Support & Contact

- **Repository**: [git.vish.gg/Vish/homelab](https://git.vish.gg/Vish/homelab)
- **Issues**: Use the repository issue tracker
- **Chat**: Available on Fluxer (st.vish.gg)
- **Documentation Issues**: Create issue with "documentation" label

---

**Last Updated**: March 7, 2026  
**Total Documents**: 80+ documentation files  
**Coverage**: Complete infrastructure and operational procedures  
**Maintenance**: Active and regularly updated