Skip to content
This repository was archived by the owner on Dec 30, 2025. It is now read-only.

Commit 1443d1a

Browse files
committed
docs: add project documentation
1 parent 309f685 commit 1443d1a

21 files changed

+14484
-294
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,38 @@ make build
233233

234234
## Documentation
235235

236-
- [SSL Setup](./docs/SSL.md)
237-
- [Secret Management](./docs/SECRET_MANAGEMENT.md)
238-
- [User Modes](./docs/user-modes.md)
236+
### 🚀 Getting Started
237+
- [Quick Start](README.md#quick-start) - Basic installation and setup
238+
- [Configuration](README.md#configuration) - Environment variables and settings
239+
- [Troubleshooting](./docs/TROUBLESHOOTING.md) - Common issues and solutions
240+
241+
### 🏗️ Core Components
242+
- [UnrealIRCd Server](./docs/UNREALIRCD.md) - IRC server configuration and management
243+
- [Atheme Services](./docs/ATHEME.md) - IRC services (NickServ, ChanServ, etc.)
244+
- [Modules](./docs/MODULES.md) - UnrealIRCd module system and third-party extensions
245+
- [WebPanel](./docs/WEBPANEL.md) - Web-based administration interface
246+
- [Gamja Client](./docs/GAMJA.md) - Modern web IRC client
247+
248+
### 🐳 Infrastructure
249+
- [Docker Setup](./docs/DOCKER.md) - Containerization, volumes, and networking
250+
- [Makefile Commands](./docs/MAKE.md) - Build automation and management commands
251+
- [Configuration](./docs/CONFIG.md) - Template system and environment variables
252+
- [CI/CD Pipeline](./docs/CI_CD.md) - GitHub Actions workflows and automation
253+
- [Testing](./docs/TESTING.md) - Comprehensive test suite and framework
254+
255+
### 🔒 Security & Operations
256+
- [SSL Certificates](./docs/SSL.md) - Let's Encrypt automation and certificate management
257+
- [Secret Management](./docs/SECRET_MANAGEMENT.md) - Passwords, API tokens, and security practices
258+
- [User Modes](./docs/USERMODES.md) - IRC user mode reference and configuration
259+
- [Backup & Recovery](./docs/BACKUP_RECOVERY.md) - Data protection and disaster recovery
260+
- [Monitoring](./docs/MONITORING.md) - Health checks, metrics, logging, and alerting
261+
262+
### 🔌 APIs & Integration
263+
- [API Reference](./docs/API.md) - JSON-RPC API and WebSocket support
264+
- [Scripts](./docs/SCRIPTS.md) - Management and utility scripts
265+
266+
### 🛠️ Development
267+
- [Development Guide](./docs/DEVELOPMENT.md) - Local setup, contribution guidelines, and workflow
239268

240269
## License
241270

0 commit comments

Comments
 (0)