Skip to content

Latest commit

 

History

History
200 lines (180 loc) · 19.3 KB

TABLEOFCONTENTS.md

File metadata and controls

200 lines (180 loc) · 19.3 KB

Documentation Table of Contents

Purpose: Quick navigation for AI to locate relevant documentation without reading all files.

Authentication & Users

Configuration & Setup

Database & Data Models

Plex Integration

Audiobookshelf Integration

Reading Shelves (Goodreads, Hardcover)

Audible Integration

E-book Support (First-Class)

Automation Pipeline

Background Jobs

Logging

Notifications

Frontend Components

BookDate (AI Recommendations)

Admin Features

Fixes & Improvements

Deployment

Testing

Feature-Specific Lookups

"How do I add a new audiobook?" → integrations/audible.md (scraping), phase3/README.md (automation) "How do I configure multiple download clients?" → phase3/download-clients.md "How do torrent downloads work?" → phase3/qbittorrent.md, backend/services/jobs.md "How do Usenet/NZB downloads work?" → phase3/sabnzbd.md, phase3/download-clients.md, backend/services/jobs.md "Can I use both qBittorrent and SABnzbd?" → phase3/download-clients.md "How do I use NZBGet instead of SABnzbd?" → phase3/download-clients.md "How do I use Transmission instead of qBittorrent?" → phase3/download-clients.md "How do I set different download paths per client?" → phase3/download-clients.md "How do I test a branch end to end without touching my own Docker setup?" → testing/e2e-harness.md "How does Plex matching work?" → integrations/plex.md "How does e-book support work?" → integrations/ebook-sidecar.md "How do I enable e-book downloads?" → integrations/ebook-sidecar.md, settings-pages.md "How do I configure ebook sources (Anna's Archive vs Indexer)?" → settings-pages.md "How does ebook indexer search work?" → integrations/ebook-sidecar.md "How do I configure ebook categories per indexer?" → settings-pages.md "How does ebook ranking work?" → phase3/ranking-algorithm.md "What happens when I delete an ebook request?" → integrations/ebook-sidecar.md "Why do ebook requests have an orange badge?" → integrations/ebook-sidecar.md "How do scheduled jobs work?" → backend/services/scheduler.md "How do I configure external services?" → setup-wizard.md, settings-pages.md "What's the database schema?" → backend/database.md "How does authentication work?" → backend/services/auth.md "How do I change my password?" → backend/services/auth.md (local users only - accessed via user menu in header) "Local admin can't log in / 'Invalid username or password' with correct credentials" → admin-features/credential-recovery.md "How do I recover from a lost CONFIG_ENCRYPTION_KEY?" → admin-features/credential-recovery.md "How do I delete requests?" → admin-features/request-deletion.md "How do I approve/deny user requests?" → admin-features/request-approval.md "How do I enable auto-approve for requests?" → admin-features/request-approval.md "How does the release blocklist work?" → admin-features/release-blocklist.md "Why does the same bad release keep getting re-downloaded?" → admin-features/release-blocklist.md (it shouldn't anymore — auto-blocked on permanent failure) "How do I unblock a release?" → admin-features/release-blocklist.md (admin → /admin/blocklist → Unblock, or chip on the request row) "How does the admin book info modal work?" → admin-features/request-approval.md, frontend/components.md "How do I customize audiobook folder organization?" → settings-pages.md, phase3/file-organization.md "How do I deploy?" → deployment/docker.md (multi-container), deployment/unified.md (all-in-one) "How do I use the unified container?" → deployment/unified.md "Download client / OIDC / Plex stopped connecting over HTTPS after the upgrade" → deployment/unified.md (Node 24 refuses weak TLS keys) "Why can't RMAB find my downloaded files?" → deployment/volume-mapping.md "How do I set up volume mapping for qBittorrent/Transmission/SABnzbd/NZBGet?" → deployment/volume-mapping.md "OAuth redirects to localhost / PUBLIC_URL not working" → backend/services/environment.md "What environment variables do I need?" → backend/services/environment.md "How does chapter merging work?" → features/chapter-merging.md "How does logging work?" → backend/services/logging.md "How do BookDate card stack animations work?" → features/bookdate-animations.md "How does Audiobookshelf integration work?" → src/lib/services/audiobookshelf/api.ts, src/lib/services/library/AudiobookshelfLibraryService.ts "How do I use OIDC/Authentik/Keycloak?" → backend/services/auth.md "How do I switch from Plex to Audiobookshelf?" → Setup wizard (re-run setup with different backend mode) "How does library thumbnail caching work?" → features/library-thumbnail-cache.md "Why do BookDate library books show placeholders?" → features/library-thumbnail-cache.md "How does file hash matching work?" → fixes/file-hash-matching.md "Why is ABS matching the wrong book?" → fixes/file-hash-matching.md (file hash prevents false positives) "How do I customize my home page?" → features/home-sections.md "How do Audible categories work?" → features/home-sections.md "How do I add category sections to the home page?" → features/home-sections.md "How do Goodreads shelves work?" → backend/services/goodreads-sync.md "How do Hardcover shelves work?" → backend/services/hardcover-sync.md "How do I add a new shelf provider?" → backend/services/goodreads-sync.md "How does the shelf sync core work?" → backend/services/goodreads-sync.md "How does bulk import work?" → features/bulk-import.md "How do I import multiple audiobooks at once?" → features/bulk-import.md "How does the bulk import scanner detect audiobooks?" → features/bulk-import.md "Why is a series page blank / showing no books, then fine after a refresh?" → integrations/audible.md (Audible A/B-serves two layouts; parsers handle both)