Lukas
486c5440f2
Added documentation for API, architecture, configuration, database, development guide, testing, and navigation. Includes helper scripts, diagrams, and guides for NFO files and migration.
40 lines
2.4 KiB
Markdown
40 lines
2.4 KiB
Markdown
# Aniworld Documentation
|
|
|
|
## Overview
|
|
|
|
This directory contains all documentation for the Aniworld anime download manager project.
|
|
|
|
## Documentation Structure
|
|
|
|
| Document | Purpose | Target Audience |
|
|
| ---------------------------------------- | ---------------------------------------------- | ---------------------------------- |
|
|
| [ARCHITECTURE.md](ARCHITECTURE.md) | System architecture and design decisions | Architects, Senior Developers |
|
|
| [API.md](API.md) | REST API reference and WebSocket documentation | Frontend Developers, API Consumers |
|
|
| [DEVELOPMENT.md](DEVELOPMENT.md) | Developer setup and contribution guide | All Developers |
|
|
| [DEPLOYMENT.md](DEPLOYMENT.md) | Deployment and operations guide | DevOps, System Administrators |
|
|
| [DATABASE.md](DATABASE.md) | Database schema and data models | Backend Developers |
|
|
| [TESTING.md](TESTING.md) | Testing strategy and guidelines | QA Engineers, Developers |
|
|
| [SECURITY.md](SECURITY.md) | Security considerations and guidelines | Security Engineers, All Developers |
|
|
| [CONFIGURATION.md](CONFIGURATION.md) | Configuration options reference | Operators, Developers |
|
|
| [CHANGELOG.md](CHANGELOG.md) | Version history and changes | All Stakeholders |
|
|
| [TROUBLESHOOTING.md](TROUBLESHOOTING.md) | Common issues and solutions | Support, Operators |
|
|
| [features.md](features.md) | Feature list and capabilities | Product Owners, Users |
|
|
| [instructions.md](instructions.md) | AI agent development instructions | AI Agents, Developers |
|
|
|
|
## Documentation Standards
|
|
|
|
- All documentation uses Markdown format
|
|
- Keep documentation up-to-date with code changes
|
|
- Include code examples where applicable
|
|
- Use clear, concise language
|
|
- Include diagrams for complex concepts (use Mermaid syntax)
|
|
|
|
## Contributing to Documentation
|
|
|
|
When adding or updating documentation:
|
|
|
|
1. Follow the established format in each document
|
|
2. Update the README.md if adding new documents
|
|
3. Ensure cross-references are valid
|
|
4. Review for spelling and grammar
|