debian-forge/generated_docs/README.md
robojerk 61e7caaddb
Some checks are pending
Checks / Spelling (push) Waiting to run
Checks / Python Linters (push) Waiting to run
Checks / Shell Linters (push) Waiting to run
Checks / 📦 Packit config lint (push) Waiting to run
Checks / 🔍 Check for valid snapshot urls (push) Waiting to run
Checks / 🔍 Check JSON files for formatting consistency (push) Waiting to run
Generate / Documentation (push) Waiting to run
Generate / Test Data (push) Waiting to run
Tests / Unittest (push) Waiting to run
Tests / Assembler test (legacy) (push) Waiting to run
Tests / Smoke run: unittest as normal user on default runner (push) Waiting to run
Did stuff
2025-08-26 11:52:32 -07:00

36 lines
1.3 KiB
Markdown

# Debian Forge Documentation Index
*Generated on: 2025-08-23 09:39:21*
## Documentation Overview
This directory contains comprehensive documentation for the Debian Forge project.
## Available Documentation
### 📚 [Technical Documentation](TECHNICAL_DOCUMENTATION.md)
Comprehensive technical reference including architecture, API documentation, and system specifications.
### 📖 [User Guide](USER_GUIDE.md)
User-friendly guide for using Debian Forge, including getting started, blueprint creation, and troubleshooting.
### 🚀 [Deployment Guide](DEPLOYMENT_GUIDE.md)
Step-by-step deployment instructions, system requirements, and configuration details.
### 🔧 [Maintenance Guide](MAINTENANCE_GUIDE.md)
Operational procedures, troubleshooting guides, and maintenance best practices.
## Quick Start
1. **New Users**: Start with the [User Guide](USER_GUIDE.md)
2. **System Administrators**: Review the [Deployment Guide](DEPLOYMENT_GUIDE.md)
3. **Developers**: Reference the [Technical Documentation](TECHNICAL_DOCUMENTATION.md)
4. **Operations**: Use the [Maintenance Guide](MAINTENANCE_GUIDE.md)
## Documentation Maintenance
This documentation is automatically generated and should be updated when:
- New features are added to the system
- Configuration options change
- Security procedures are updated
- Deployment processes are modified