basic structure

homelabbing/docs/how-to-use-this-guide.md

@@ -0,0 +1,85 @@
+# How to Use This Documentation
+
+Welcome to the **Homelab Documentation** – a complete reference for planning, building, and maintaining your self-hosted infrastructure.
+
+This knowledge base is organized into **three main categories** in the top navigation:  
+- **Software** – Applications and services you can self-host  
+- **Hardware** – Physical servers, storage, and network equipment  
+- **Know-How** – Linux fundamentals, networking, and security
+
+---
+
+## 📂 Category Structure
+
+### **Software**
+Guides for installing, configuring, and running self-hosted applications.
+- **Media Services** – Streaming, automation, indexing, transcoding
+- **Productivity Tools** – File sync, document management, collaboration
+- **Monitoring & Management** – Metrics, logs, automation, backups
+- **Other Applications** – Any other useful self-hosted services
+
+**Example:**  
+[Docker Installation Guide](knowhow/docker)  
+[Service Installation Example](software/mediastack)
+
+---
+
+### **Hardware**
+Documentation about your physical homelab setup.
+- **Servers** – Build guides for different performance tiers
+- **Storage** – RAID, ZFS, NAS integration
+- **Networking Equipment** – Routers, switches, WiFi APs
+- **Power & UPS** – Power protection and energy efficiency
+
+**Example:**  
+[Starter Server Build](hardware/server)
+
+---
+
+### **Know-How**
+General technical knowledge for running and securing a homelab.
+- **Linux**
+  - Basics – Commands, filesystem, permissions
+  - Docker – Installation, Compose, Swarm Mode
+- **Networking**
+  - VLANs, subnets, DNS, VPN setup
+- **Security**
+  - TLS/SSL, reverse proxy configuration
+  - MFA, firewall, access control
+  - Backup strategies
+
+**Example:**  
+[Linux Basics](knowhow/linux/basics)
+
+---
+
+## 🛠 How to Navigate
+
+1. **Choose a Category** – Use the top navigation to open *Software*, *Hardware*, or *Know-How*.  
+2. **Expand the Sidebar** – Each category contains subtopics with their own guides.  
+3. **Follow Links** – Many guides link to related topics for better context.  
+4. **Copy & Paste** – All commands are provided in ready-to-use code blocks.  
+
+---
+
+## 🚀 Suggested Starting Path
+
+If you’re new to self-hosting:
+1. Follow the [Docker Installation Guide](knowhow/docker)  
+2. Deploy a basic service of your choice  
+3. Set up reverse proxy and SSL for secure access  
+4. Learn networking and security basics in *Know-How*  
+5. Expand with automation, backups, and monitoring
+
+---
+
+## 📚 Resources
+
+- [Docker Documentation](https://docs.docker.com/)
+- [Jellyfin Docs](https://jellyfin.org/docs/)
+- [Awesome-Selfhosted](https://github.com/awesome-selfhosted/awesome-selfhosted)
+- [selfh.st – Self-Hosting Knowledge Base](https://selfh.st/)
+
+---
+
+**Tip:** Keep your configuration files, `docker-compose.yml` files, and infrastructure documentation in version control for easy recovery.