Complete documentation map for Metarr - intelligent metadata management for media libraries.
For Developers:
- CLAUDE.md - AI assistant workflow rules (CRITICAL)
- WORKFLOW.md - Development workflow (CRITICAL)
- ROADMAP.md - Current priorities (CRITICAL)
Design principles and conceptual documentation for how Metarr processes media.
| Job | Documentation | Purpose |
|---|---|---|
| Scanning | concepts/Scanning/ | Discover, classify, identify media |
| Enrichment | concepts/Enrichment/ | Gather metadata and select assets |
| Publishing | concepts/Publishing/ | Deploy to library for players |
| Player Sync | concepts/PlayerSync/ | Notify media players of changes |
| Job | Documentation | Purpose |
|---|---|---|
| Verification | concepts/Verification/ | Ensure cache↔library consistency |
| Notification | concepts/Notification/ | Send filtered alerts to users |
Media-specific implementation for each operational concept.
| Media Type | Documentation | Status |
|---|---|---|
| Movies | implementation/Movies/ | Complete |
| TV Shows | Planned | - |
| Music | Planned | - |
| Component | Documentation | Description |
|---|---|---|
| Providers | implementation/Providers/ | Provider API integration details |
| Player Sync | implementation/PlayerSync/ | Media player integration (Kodi, Jellyfin, Plex) |
| Document | Description |
|---|---|
| OVERVIEW.md | System architecture at a glance |
| DATABASE.md | Complete database schema reference |
| JOB_QUEUE.md | Job system and worker pool |
| API.md | REST API + WebSocket communication |
| Document | Description |
|---|---|
| ASSET_MANAGEMENT/README.md | Asset system overview (two-copy architecture) |
| ASSET_MANAGEMENT/ASSET_TYPES.md | Media-specific asset types |
| ASSET_MANAGEMENT/CONTENT_ADDRESSING.md | SHA256 sharding system |
| ASSET_MANAGEMENT/TWO_COPY_SYSTEM.md | Cache vs library architecture |
| ASSET_MANAGEMENT/FIELD_LOCKING.md | Field locking behavior |
Technical documentation for the job-driven automation system.
| Document | Description |
|---|---|
| architecture/JOB_QUEUE.md | Job priorities, worker pools, pass-through behavior |
| Document | Description |
|---|---|
| README.md | Provider capabilities and selection strategies |
| RATE_LIMITING.md | Rate limiting, circuit breakers, backoff |
| Document | Description |
|---|---|
| TMDB.md | TMDB API integration |
| TVDB.md | TVDB API integration |
| OMDB.md | OMDb API (IMDb ratings, RT, Metacritic) |
| FANART.md | Fanart.tv artwork integration |
| MUSICBRAINZ.md | MusicBrainz integration (planned) |
| LOCAL.md | Local NFO parsing and backup |
| Document | Description |
|---|---|
| README.md | Frontend documentation overview |
| ARCHITECTURE.md | Frontend architecture and structure |
| COMPONENT_GUIDELINES.md | Component creation rules and principles |
| COMPONENT_REFERENCE.md | Complete component inventory |
| STYLING_GUIDE.md | Design tokens and styling patterns |
| STATE_MANAGEMENT.md | TanStack Query + hooks |
| API_LAYER.md | API communication patterns |
| ERROR_HANDLING.md | Error strategy and user feedback |
| Document | Description |
|---|---|
| ASSET_SCORING.md | Asset scoring algorithm deep dive |
| NFO_FORMAT.md | Complete Kodi NFO specification |
| PATH_MAPPING.md | Docker/NAS path mapping scenarios |
| WEBHOOKS.md | Radarr/Sonarr/Lidarr webhook handling |
| CLI_REFERENCE.md | npm scripts and commands |
| Document | Description |
|---|---|
| WORKFLOW.md | Complete development workflow (CRITICAL) |
| ROADMAP.md | Current tasks and priorities (CRITICAL) |
| PLANNING_WORKFLOW.md | Planning mode with named agents (CRITICAL) |
| DOCUMENTATION_RULES.md | Meta-documentation guidelines |
| TESTING.md | Test infrastructure and strategy |
| CODING_STANDARDS.md | TypeScript/React coding standards |
For AI Assistants: Always read CLAUDE.md, WORKFLOW.md, ROADMAP.md at session start. Use concepts/ for conceptual understanding, implementation/ for media-specific details.
For Developers: Start with WORKFLOW.md for complete development process.
Context Efficiency: Use directory READMEs as entry points, then load specific files as needed.