xorbitlab
/
nextav
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
nextav/docs
History
tigeren 7d8694b6f5 feat(clusters): add bookmark and rating features to video player 
- Enable display of bookmarks and ratings in the player UI
- Add handlers for bookmarking and unbookmarking actions
- Implement rating functionality with corresponding event handler
- Enhance user interaction by integrating these new controls
- Improve state management related to video selection and player display
 		2025-10-12 09:09:28 +00:00
..
archive docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
ARTPLAYER_DIRECT_PLAYBACK_ENHANCEMENT_PLAN.md refactor(docs): remove deprecated process management and progress bar guides 2025-09-22 17:40:59 +00:00
CLUSTER_FOLDER_API_TESTS.md feat(clusters): add folder view tab with backend and frontend support 2025-10-12 07:56:15 +00:00
CLUSTER_FOLDER_PHASE1_COMPLETE.md feat(clusters): add folder view tab with backend and frontend support 2025-10-12 07:56:15 +00:00
CLUSTER_FOLDER_PHASE2_COMPLETE.md feat(clusters): add folder view tab with backend and frontend support 2025-10-12 07:56:15 +00:00
CLUSTER_FOLDER_VIEW_DESIGN.md feat(clusters): add folder view tab with backend and frontend support 2025-10-12 07:56:15 +00:00
CLUSTER_FOLDER_VIEW_SUMMARY.md feat(clusters): add folder view tab with backend and frontend support 2025-10-12 07:56:15 +00:00
DATABASE_MIGRATION_GUIDE.md feat(folder-bookmarks): add folder bookmarks feature with migration support 2025-10-10 15:31:45 +00:00
IMPLEMENTATION_COMPLETE.md add new plan 2025-09-28 17:37:28 +00:00
IMPLEMENTATION_TASKS.md add new plan 2025-09-28 17:37:28 +00:00
JELLYFIN_TRANSCODING_ARCHITECTURE.md refactor(docs): remove deprecated process management and progress bar guides 2025-09-22 17:40:59 +00:00
LIBRARY_CLUSTER_ARCHITECTURE.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
LIBRARY_CLUSTER_FEATURE.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
LIBRARY_CLUSTER_IMPLEMENTATION.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
LIBRARY_CLUSTER_INDEX.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
LIBRARY_CLUSTER_PROGRESS.md feat(clusters): add folder view tab with backend and frontend support 2025-10-12 07:56:15 +00:00
LIBRARY_CLUSTER_SUMMARY.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
LIBRARY_CLUSTER_UI_MOCKUPS.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
LOCAL_PLAYER_AUTO_CLOSE_FIX.md feat(clusters): add bookmark and rating features to video player 2025-10-12 09:09:28 +00:00
MIGRATION_README.md feat(folder-bookmarks): add folder bookmarks feature with migration support 2025-10-10 15:31:45 +00:00
README.md docs(deployment): update Docker image tag to 1.3 in deployment guide 2025-10-11 16:24:41 +00:00
THUMBNAIL_FIX_SUMMARY.md feat(api): include rating and bookmark metadata in media queries 2025-10-12 09:03:17 +00:00
TRANSCODING_REMOVAL_DESIGN.md add new plan 2025-09-28 17:37:28 +00:00
TRANSCODING_REMOVAL_SUMMARY.md add new plan 2025-09-28 17:37:28 +00:00
TRANSCODING_REMOVAL_TRACKING.md add new plan 2025-09-28 17:37:28 +00:00
TS_FILE_HANDLING_GUIDE.md feat(streaming): add .ts file HLS streaming and container conversion support 2025-09-29 19:21:46 +00:00
TS_HLS_TECH.md feat(hls): implement dynamic FFmpeg segmentation for merged .ts files 2025-10-01 15:40:23 +00:00
VIDEO_FORMAT_COMPATIBILITY_ANALYSIS.md refactor(docs): remove deprecated process management and progress bar guides 2025-09-22 17:40:59 +00:00

README.md

NextAV Documentation

Welcome to the NextAV documentation repository. This directory contains comprehensive documentation for all major features and technical designs.

📚 Documentation Overview

🆕 Latest: 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

Quick Links:

📂 Documentation Categories

Features & Enhancements

Library Cluster Feature (NEW)

Group and organize libraries by content category.

Video Playback Enhancements

Transcoding System

TS File Handling

Database & Migration

Implementation & Tracking

🚀 Quick Start Guide

For New Developers

  1. Understand the Project

    • Read the main README.md in the root directory
    • Review PRD.md for project requirements

  2. Set Up Development Environment

  3. Explore Features

For Product Owners

  1. Feature Overview

  2. Technical Architecture

For QA Engineers

  1. Testing Guides

  2. Database Testing

📖 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/ 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
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: 17+ active documents
  • Total Size: ~250 KB
  • Categories: 5 main categories
  • Latest Update: 2025-10-11

🆘 Need Help?

Can't Find What You Need?

  1. Check the Library Cluster Index for the latest feature
  2. Browse by category above
  3. Search for keywords in file names
  4. Check the 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. Library Cluster Feature - New feature for library organization
  2. Video Playback Optimization - Improving compatibility and performance
  3. Database Migration - Ongoing schema improvements

📅 Recent Updates

Date Document Change
2025-10-11 Library Cluster docs Initial documentation package created
[Previous] Various See individual documents for history

🔗 External Resources

Documentation Version: 1.0
Last Updated: 2025-10-11
Maintainer: Development Team