Welcome to the AVPlayback project documentation. This directory contains comprehensive guides for understanding and contributing to the project.
Start here to understand the project's architecture.
- Modular design principles
- Layer responsibilities (App, UI, Business Logic, Foundation)
- Module overview (AppFoundation, PlaybackKit, PlaybackUI)
- Design patterns (MVVM, Dependency Injection, Protocol-Oriented Design)
- Data flow and communication patterns
- Future expansion plans
When to read: Before making architectural decisions or adding new modules.
Essential guide for day-to-day development.
- Getting started and initial setup
- Development workflow and best practices
- Coding standards and style guidelines
- Testing guidelines
- Building, running, and debugging
- Git workflow and commit conventions
When to read: Before writing code, setting up the project, or troubleshooting issues.
Detailed reference for the modular architecture.
- Catalog of all modules with detailed documentation
- Public APIs and usage examples
- Module-specific guidelines and best practices
- How to create new modules
- Module maintenance and versioning
When to read: When working with specific modules or creating new ones.
- Project Rules: See ../.clinerules for AI assistant configuration
- Git Workflow: DEVELOPMENT.md#git-workflow
- Adding Modules: MODULES.md#adding-new-modules
- Read ARCHITECTURE.md to understand the big picture
- Review DEVELOPMENT.md for coding standards
- Explore MODULES.md for module-specific details
- Check ../.clinerules for project conventions
Documentation should evolve with the codebase:
- Architecture changes: Update ARCHITECTURE.md
- New modules: Update MODULES.md
- Workflow changes: Update DEVELOPMENT.md
- New conventions: Update ../.clinerules
Good documentation is maintained documentation! 📚