277 lines
8.3 KiB
Markdown
277 lines
8.3 KiB
Markdown
# NextAV Documentation
|
|
|
|
Welcome to the NextAV documentation repository. This directory contains comprehensive documentation for all major features and technical designs.
|
|
|
|
---
|
|
|
|
## 📚 Documentation Overview
|
|
|
|
### 🆕 Latest: Surprise Me - Video Recommendation Feature
|
|
|
|
The **Surprise Me** feature is a lightweight video recommendation system that helps you rediscover videos in your personal collection through smart algorithms.
|
|
|
|
**Start Here**: 📑 [Surprise Me Documentation Index](SURPRISE_ME_INDEX.md)
|
|
|
|
**Quick Links**:
|
|
- ⚡ [Quick Start Guide](SURPRISE_ME_QUICKSTART.md) - **Fastest way to implement**
|
|
- 📋 [Quick Summary](SURPRISE_ME_SUMMARY.md) - Overview and key concepts
|
|
- 📖 [Complete Design](SURPRISE_ME_RECOMMENDATION_DESIGN.md) - Full specification
|
|
- 🏗️ [Architecture Diagrams](SURPRISE_ME_ARCHITECTURE_DIAGRAM.md) - Visual system design
|
|
- 💻 [Implementation Examples](SURPRISE_ME_IMPLEMENTATION_EXAMPLES.md) - Code snippets
|
|
|
|
### Library Cluster Feature
|
|
|
|
The **Library Cluster** feature allows you to group multiple libraries that contain similar content for better organization and unified access.
|
|
|
|
**Start Here**: [Library Cluster Index](LIBRARY_CLUSTER_INDEX.md)
|
|
|
|
**Quick Links**:
|
|
- [Executive Summary](LIBRARY_CLUSTER_SUMMARY.md) - Overview and FAQs
|
|
- [Feature Specification](LIBRARY_CLUSTER_FEATURE.md) - Complete design
|
|
- [Architecture](LIBRARY_CLUSTER_ARCHITECTURE.md) - Technical details
|
|
- [Implementation Guide](LIBRARY_CLUSTER_IMPLEMENTATION.md) - Step-by-step coding
|
|
- [UI Mockups](LIBRARY_CLUSTER_UI_MOCKUPS.md) - Design reference
|
|
|
|
---
|
|
|
|
## 📂 Documentation Categories
|
|
|
|
### Features & Enhancements
|
|
|
|
#### Surprise Me - Video Recommendation (NEW)
|
|
Lightweight recommendation system for personal video discovery.
|
|
- 📑 [Documentation Index](SURPRISE_ME_INDEX.md) - **Complete navigation hub**
|
|
- ⚡ [Quick Start Guide](SURPRISE_ME_QUICKSTART.md) - **Start here for implementation**
|
|
- 📋 [Quick Summary](SURPRISE_ME_SUMMARY.md) - Overview and concepts
|
|
- 📖 [Complete Design](SURPRISE_ME_RECOMMENDATION_DESIGN.md) - Full specification
|
|
- 🏗️ [Architecture Diagrams](SURPRISE_ME_ARCHITECTURE_DIAGRAM.md) - Visual system design
|
|
- 💻 [Implementation Examples](SURPRISE_ME_IMPLEMENTATION_EXAMPLES.md) - Code snippets
|
|
|
|
#### Library Cluster Feature
|
|
Group and organize libraries by content category.
|
|
- [Index](LIBRARY_CLUSTER_INDEX.md)
|
|
- [Summary](LIBRARY_CLUSTER_SUMMARY.md)
|
|
- [Feature Spec](LIBRARY_CLUSTER_FEATURE.md)
|
|
- [Architecture](LIBRARY_CLUSTER_ARCHITECTURE.md)
|
|
- [Implementation](LIBRARY_CLUSTER_IMPLEMENTATION.md)
|
|
- [UI Mockups](LIBRARY_CLUSTER_UI_MOCKUPS.md)
|
|
|
|
#### Video Playback Enhancements
|
|
- [ArtPlayer Direct Playback Enhancement](ARTPLAYER_DIRECT_PLAYBACK_ENHANCEMENT_PLAN.md)
|
|
- [Video Format Compatibility Analysis](VIDEO_FORMAT_COMPATIBILITY_ANALYSIS.md)
|
|
|
|
#### Transcoding System
|
|
- [Jellyfin Transcoding Architecture](JELLYFIN_TRANSCODING_ARCHITECTURE.md)
|
|
- [Transcoding Removal Design](TRANSCODING_REMOVAL_DESIGN.md)
|
|
- [Transcoding Removal Summary](TRANSCODING_REMOVAL_SUMMARY.md)
|
|
- [Transcoding Removal Tracking](TRANSCODING_REMOVAL_TRACKING.md)
|
|
|
|
#### TS File Handling
|
|
- [TS File Handling Guide](TS_FILE_HANDLING_GUIDE.md)
|
|
- [TS HLS Technical Details](TS_HLS_TECH.md)
|
|
|
|
---
|
|
|
|
### Database & Migration
|
|
|
|
- [Database Migration Guide](DATABASE_MIGRATION_GUIDE.md)
|
|
- [Migration README](MIGRATION_README.md)
|
|
|
|
---
|
|
|
|
### Implementation & Tracking
|
|
|
|
- [Implementation Tasks](IMPLEMENTATION_TASKS.md)
|
|
- [Implementation Complete](IMPLEMENTATION_COMPLETE.md)
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start Guide
|
|
|
|
### For New Developers
|
|
|
|
1. **Understand the Project**
|
|
- Read the main [README.md](../README.md) in the root directory
|
|
- Review [PRD.md](../PRD.md) for project requirements
|
|
|
|
2. **Set Up Development Environment**
|
|
- Follow setup instructions in the main README
|
|
- Review [Database Migration Guide](DATABASE_MIGRATION_GUIDE.md)
|
|
|
|
3. **Explore Features**
|
|
- Start with [Library Cluster Feature](LIBRARY_CLUSTER_INDEX.md) (newest)
|
|
- Review [Video Playback Enhancements](ARTPLAYER_DIRECT_PLAYBACK_ENHANCEMENT_PLAN.md)
|
|
|
|
### For Product Owners
|
|
|
|
1. **Feature Overview**
|
|
- [Library Cluster Summary](LIBRARY_CLUSTER_SUMMARY.md)
|
|
- [Video Format Compatibility](VIDEO_FORMAT_COMPATIBILITY_ANALYSIS.md)
|
|
|
|
2. **Technical Architecture**
|
|
- [Library Cluster Architecture](LIBRARY_CLUSTER_ARCHITECTURE.md)
|
|
- [Jellyfin Transcoding Architecture](JELLYFIN_TRANSCODING_ARCHITECTURE.md)
|
|
|
|
### For QA Engineers
|
|
|
|
1. **Testing Guides**
|
|
- [Library Cluster Implementation](LIBRARY_CLUSTER_IMPLEMENTATION.md) (includes test checklists)
|
|
- [TS File Handling Guide](TS_FILE_HANDLING_GUIDE.md)
|
|
|
|
2. **Database Testing**
|
|
- [Database Migration Guide](DATABASE_MIGRATION_GUIDE.md)
|
|
|
|
---
|
|
|
|
## 📖 Documentation Standards
|
|
|
|
### Document Types
|
|
|
|
#### Specification Documents
|
|
- Define features and requirements
|
|
- Include use cases and examples
|
|
- Examples: `*_FEATURE.md`, `*_DESIGN.md`
|
|
|
|
#### Architecture Documents
|
|
- Technical system design
|
|
- Database schemas and API definitions
|
|
- Examples: `*_ARCHITECTURE.md`, `*_TECH.md`
|
|
|
|
#### Implementation Guides
|
|
- Step-by-step instructions
|
|
- Code examples and snippets
|
|
- Examples: `*_IMPLEMENTATION.md`, `*_GUIDE.md`
|
|
|
|
#### Summary Documents
|
|
- Quick overviews and FAQs
|
|
- Executive summaries
|
|
- Examples: `*_SUMMARY.md`, `*_INDEX.md`
|
|
|
|
---
|
|
|
|
## 🗂️ Archive
|
|
|
|
Older documentation and historical records are stored in the [`archive/`](archive/) directory.
|
|
|
|
---
|
|
|
|
## 📝 Contributing to Documentation
|
|
|
|
### Adding New Documentation
|
|
|
|
1. **Choose the Right Type**
|
|
- Feature specs for new features
|
|
- Guides for how-to instructions
|
|
- Summaries for quick references
|
|
|
|
2. **Follow Naming Conventions**
|
|
- Use UPPERCASE for file names
|
|
- Use underscores for word separation
|
|
- Example: `FEATURE_NAME_DOCUMENT_TYPE.md`
|
|
|
|
3. **Include Standard Sections**
|
|
- Overview/Introduction
|
|
- Table of contents for long docs
|
|
- Examples and use cases
|
|
- Version and date information
|
|
|
|
4. **Cross-Reference**
|
|
- Link to related documents
|
|
- Update index files
|
|
- Add to this README
|
|
|
|
### Updating Existing Documentation
|
|
|
|
1. Update the version number and date
|
|
2. Add changes to a "Version History" section
|
|
3. Update any related documents
|
|
4. Test all links
|
|
|
|
---
|
|
|
|
## 🔍 Finding Documentation
|
|
|
|
### By Topic
|
|
|
|
| Topic | Key Documents |
|
|
|-------|--------------|
|
|
| **Video Discovery** | Surprise Me Summary, Surprise Me Design |
|
|
| **Library Management** | Library Cluster Feature docs |
|
|
| **Video Playback** | ArtPlayer Enhancement, Format Compatibility |
|
|
| **Database** | Migration Guide, Migration README |
|
|
| **Transcoding** | Jellyfin Architecture, Removal docs |
|
|
| **File Formats** | TS File Handling, TS HLS Tech |
|
|
|
|
### By Role
|
|
|
|
| Role | Recommended Docs |
|
|
|------|------------------|
|
|
| **Developer** | Implementation guides, Architecture docs |
|
|
| **Product Owner** | Summary docs, Feature specs |
|
|
| **QA Engineer** | Implementation guides (testing sections) |
|
|
| **Designer** | UI Mockups, Feature specs (UX sections) |
|
|
|
|
---
|
|
|
|
## 📊 Documentation Statistics
|
|
|
|
- **Total Documents**: 23+ active documents
|
|
- **Total Size**: ~550 KB
|
|
- **Categories**: 5 main categories
|
|
- **Latest Update**: 2025-10-12
|
|
|
|
---
|
|
|
|
## 🆘 Need Help?
|
|
|
|
### Can't Find What You Need?
|
|
|
|
1. Check the [Library Cluster Index](LIBRARY_CLUSTER_INDEX.md) for the latest feature
|
|
2. Browse by category above
|
|
3. Search for keywords in file names
|
|
4. Check the [archive/](archive/) for older docs
|
|
|
|
### Documentation Issues?
|
|
|
|
If you find:
|
|
- Broken links
|
|
- Outdated information
|
|
- Missing documentation
|
|
- Unclear instructions
|
|
|
|
Please create an issue or update the documentation directly.
|
|
|
|
---
|
|
|
|
## 🎯 Current Focus
|
|
|
|
The project is currently focused on:
|
|
1. **Surprise Me Feature** - Video recommendation system for personal discovery
|
|
2. **Library Cluster Feature** - Library organization and grouping
|
|
3. **Video Playback Optimization** - Improving compatibility and performance
|
|
4. **Database Migration** - Ongoing schema improvements
|
|
|
|
---
|
|
|
|
## 📅 Recent Updates
|
|
|
|
| Date | Document | Change |
|
|
|------|----------|--------|
|
|
| 2025-10-12 | Surprise Me docs | Initial documentation for recommendation feature |
|
|
| 2025-10-11 | Library Cluster docs | Initial documentation package created |
|
|
| [Previous] | Various | See individual documents for history |
|
|
|
|
---
|
|
|
|
## 🔗 External Resources
|
|
|
|
- [Main Project README](../README.md)
|
|
- [Product Requirements](../PRD.md)
|
|
- [Technical Specifications](../CLAUDE.md)
|
|
|
|
---
|
|
|
|
**Documentation Version**: 1.1
|
|
**Last Updated**: 2025-10-12
|
|
**Maintainer**: Development Team
|