barbercollie/ReadMeABook
1
0
Fork 1
mirror of https://github.com/kikootwo/ReadMeABook.git synced 2026-06-02 20:30:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d3dc6cf76d45fefb9d7c399e76440c351cbabc15
ReadMeABook/documentation/TABLEOFCONTENTS.md
T
kikootwo d3dc6cf76d Add volume mapping docs and build/version metadata 
Add a volume-mapping guide and surface build/version metadata throughout the project.

Changes included:
- documentation: Add documentation/deployment/volume-mapping.md and update TABLEOFCONTENTS.md and README to reference it (helps users align download client and RMAB paths).
- CI: Capture package.json version in .github/workflows/build-unified-image.yml, pass APP_VERSION as a build-arg, and update the Discord notification to show the semantic version and pull `:latest`.
- Docker: Declare ARG APP_VERSION and expose NEXT_PUBLIC_APP_VERSION / APP_VERSION / GIT_COMMIT env vars in dockerfile.unified so runtime and client can read the semantic version and commit.
- App API/UI: Update src/app/api/version/route.ts and src/components/ui/VersionBadge.tsx to prefer semantic app version (APP_VERSION / NEXT_PUBLIC_APP_VERSION), include fullVersion and commit info, show commit in tooltip, and adjust fallback/dev labels.
- Tests: Update tests (system.routes.test.ts and VersionBadge.test.tsx) to reflect the new version/commit fields and behavior.
- Audible integration: Add ipRedirectOverride query param to multiple Audible requests to avoid IP-based region redirects.
- Misc: Bump package.json version to 1.0.0.

These changes make version information consistent between build, runtime, and UI, improve CI notifications, add user guidance for common volume-mapping issues, and harden Audible scraping against region redirects.
2026-02-05 10:26:07 -05:00

12 KiB
Raw Blame History

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

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, backend/services/jobs.md "Can I use both qBittorrent and SABnzbd?" → phase3/download-clients.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) "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 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 "Why can't RMAB find my downloaded files?" → deployment/volume-mapping.md "How do I set up volume mapping for qBittorrent/SABnzbd?" → 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)

Reference in New Issue View Git Blame Copy Permalink