mirror of
https://github.com/acedanger/shell.git
synced 2025-12-06 06:40:13 -08:00
3ce2b687ac
- Introduced `docker-deployment-manager.sh` for managing Docker stack deployments across multiple servers, including initialization, deployment, and status checks. - Added `stack-assignment-helper.sh` to analyze Docker stacks and suggest server assignments based on predefined patterns. - Removed outdated `SETUP_COMPLETE.md` file as it is no longer relevant to the current setup process. - Ref - Documentation review #11
109 lines
4.9 KiB
Markdown
109 lines
4.9 KiB
Markdown
# 📚 Documentation Table of Contents
|
|
|
|
This is a comprehensive index of all documentation available in this shell scripts and dotfiles repository.
|
|
|
|
## 🏠 Main Documentation
|
|
|
|
- [**README.md**](./README.md) - Main repository documentation and overview
|
|
- [**backup-wants.md**](./backup-wants.md) - Backup requirements and wishlist
|
|
|
|
## 🚀 Setup & Configuration
|
|
|
|
- [**Setup Complete Guide**](./setup/SETUP_COMPLETE.md) - Complete setup documentation for Ollama + Fabric integration
|
|
|
|
## 🛠️ Component Documentation
|
|
|
|
### Backup Systems
|
|
|
|
- [**Backup Media Documentation**](./docs/backup-media.md) - Media backup system documentation
|
|
- [**Enhanced Media Backup**](./docs/enhanced-media-backup.md) - Advanced media backup features
|
|
- [**Backup Media Enhancement Summary**](./docs/backup-media-enhancement-summary.md) - Summary of backup enhancements
|
|
- [**Environment Backup System**](./docs/env-backup-system.md) - Environment backup documentation
|
|
- [**Environment Backup Integration Guide**](./docs/env-backup-integration-guide.md) - Integration guide for env backups
|
|
- [**Backup Environment Safety Guide**](./docs/backup-env-safety-guide.md) - Safety guidelines for environment backups
|
|
|
|
### Plex Media Server
|
|
|
|
- [**Plex README**](./plex/README.md) - Plex scripts overview
|
|
- [**Plex Backup Documentation**](./plex/plex-backup.md) - Plex backup system guide
|
|
- [**Plex Management Guide**](./plex/plex-management.md) - Plex server management documentation
|
|
|
|
### Immich Photo Management
|
|
|
|
- [**Immich README**](./immich/README.md) - Immich backup scripts overview
|
|
- [**Immich Backup Prompt**](./immich/.prompts/immich-backup.prompt.md) - Immich backup automation prompt
|
|
- [**Immich Backup Enhancement Summary**](./docs/immich-backup-enhancement-summary.md) - Enhancement summary
|
|
- [**Immich Backup Migration Summary**](./docs/immich-backup-migration-summary.md) - Migration documentation
|
|
|
|
### Crontab & Scheduling
|
|
|
|
- [**Crontab README**](./crontab/README.md) - Crontab management overview
|
|
- [**Enhanced Crontab System**](./crontab/enhanced-crontab-system.md) - Advanced crontab management
|
|
- [**Multi-System Crontab Management**](./crontab/multi-system-crontab-management.md) - Multi-server crontab coordination
|
|
|
|
### System Configuration
|
|
|
|
- [**Dotfiles README**](./dotfiles/README.md) - Dotfiles setup and configuration guide
|
|
- [**Completions README**](./completions/README.md) - Tab completion system documentation
|
|
|
|
### Telegram Integration
|
|
|
|
- [**Telegram Bot README**](./telegram/github-issues/README.md) - Telegram backup monitoring bot
|
|
|
|
## 🧪 Development & Testing
|
|
|
|
- [**Docker Bootstrap Testing Framework**](./docs/docker-bootstrap-testing-framework.md) - Comprehensive testing framework documentation
|
|
- [**Docker Stack Deployment Strategy**](./docs/docker-stack-deployment-strategy.md) - Deployment strategy guide
|
|
- [**Production Deployment Guide**](./docs/production-deployment-guide.md) - Production deployment documentation
|
|
|
|
## 🔧 Technical Guides
|
|
|
|
### System Utilities
|
|
|
|
- [**Folder Metrics**](./docs/folder-metrics.md) - Directory analysis and metrics documentation
|
|
- [**Cleanup Alias Tracking**](./docs/cleanup-alias-tracking.md) - Alias management and cleanup guide
|
|
|
|
### Development Features
|
|
|
|
- [**Tab Completion Implementation Summary**](./docs/tab-completion-implementation-summary.md) - Tab completion system implementation
|
|
- [**Package Detection Fix Summary**](./docs/package-detection-fix-summary.md) - Package detection improvements
|
|
|
|
## 📊 Project Summaries & Reviews
|
|
|
|
- [**Documentation Review Summary**](./docs/documentation-review-summary.md) - Comprehensive documentation review
|
|
- [**Project Completion Summary**](./docs/project-completion-summary.md) - Overall project completion status
|
|
- [**Issue 11 Completion Summary**](./docs/issue-11-completion-summary.md) - Specific issue resolution summary
|
|
|
|
## ⚙️ Developer Configuration
|
|
|
|
- [**GitHub Copilot Instructions**](./.github/copilot-instructions.md) - AI assistant configuration and guidelines
|
|
|
|
---
|
|
|
|
## 📂 Directory Structure
|
|
|
|
```
|
|
📁 docs/ - Technical documentation and guides
|
|
📁 setup/ - Setup and configuration files
|
|
📁 plex/ - Plex Media Server scripts and docs
|
|
📁 immich/ - Immich photo management scripts
|
|
📁 crontab/ - Crontab management system
|
|
📁 dotfiles/ - System configuration files
|
|
📁 completions/ - Tab completion scripts
|
|
📁 telegram/ - Telegram bot integration
|
|
📁 .github/ - GitHub and development configuration
|
|
```
|
|
|
|
## 🏷️ Documentation Categories
|
|
|
|
- **🚀 Setup & Getting Started**: Essential setup guides and initial configuration
|
|
- **🛠️ System Administration**: Server management, backups, and maintenance
|
|
- **📱 Media Management**: Plex and Immich configuration and backup systems
|
|
- **🤖 Automation**: Crontab scheduling and Telegram bot integration
|
|
- **🧪 Development**: Testing frameworks and deployment strategies
|
|
- **📚 Reference**: Technical guides and troubleshooting documentation
|
|
|
|
---
|
|
|
|
*Last updated: May 29, 2025*
|