#Documentation Source Note
This documentation tree is the ReadAIrr-owned copy of the Readarr documentation set. Pages should now be checked against the current ReadAIrr/App repo before retaining inherited upstream behavior.
#Seed source
The initial Markdown files under this folder were copied from the Servarr Wiki repository:
- Source repository: https://github.com/Servarr/Wiki
- Readarr docs folder: https://github.com/Servarr/Wiki/tree/master/readarr
- Common Docker and support guides: https://github.com/Servarr/Wiki/tree/master
The content is intentionally copied into the ReadAIrr site repo so future updates can be edited, reviewed, and published from the ReadAIrr-owned documentation pipeline instead of depending on abandoned upstream links.
#Current review basis
The latest content review was performed on 2026-05-10 against the current ReadAIrr/App repo, including commits after the prior 2026-05-04 docs pass, the visible App working tree, and the live no-auth UI at http://192.168.0.228:8787. Pages were refreshed for hosted metadata defaults, custom external rreading-glasses behavior, server-side list search/paging, new Activity and Narrator views, metadata confidence review, Deep Identify/STT settings, audiobook quality preferences, and System status readiness panels.
#2026-05-10 page review checklist
| Page | Status | Review basis |
|---|---|---|
README.md |
Updated | Repo purpose and current review scope |
index.html |
Updated | Public docs landing links and current feature entry points |
api/readairr-openapi.json |
Reviewed | Docs-only OpenAPI metadata; App bundle still needs regeneration for newer controllers |
wiki/readarr/activity.md |
Updated | Live Activity navigation: Overview, Queue, History, Blocklist |
wiki/readarr/appdata-directory.md |
Reviewed | Compatibility app-data paths still use inherited Readarr naming |
wiki/readarr/calendar.md |
Updated | Live Calendar toolbar and iCal behavior |
wiki/readarr/custom-scripts.md |
Reviewed | Custom-script environment names remain inherited compatibility API |
wiki/readarr/environment-variables.md |
Updated | Current READARR__... namespaces and Compose distinction |
wiki/readarr/faq.md |
Updated | Metadata source defaults, update guidance, and current project wording |
wiki/readarr/fork-status.md |
Updated | Repo boundaries, live URL drift, and Toby action items |
wiki/readarr/installation.md |
Updated | Current container image, Postgres Compose dependency, metadata defaults |
wiki/readarr/installation_redir.md |
Reviewed | Redirect stub only |
wiki/readarr/library.md |
Updated | Live Authors, Books, Series, Narrators, Bookshelf, Unmapped views |
wiki/readarr/metadata-issues.md |
Updated | Hosted Goodreads/Hardcover defaults and custom source behavior |
wiki/readarr/postgres-setup.md |
Updated | ReadAIrr naming plus current System readiness panel |
wiki/readarr/quick-start-guide.md |
Updated | Startup, metadata defaults, download category, and match preset wording |
wiki/readarr/settings.md |
Updated | Development metadata, AI/STT, audio tags, analytics, download category |
wiki/readarr/status.md |
Updated | Status is now System Status plus metadata/database readiness notes |
wiki/readarr/supported.md |
Reviewed | Supported integration categories still align with live settings areas |
wiki/readarr/system.md |
Updated | Status panels, System tabs, and current ReadAIrr wording |
wiki/readarr/tips-and-tricks.md |
Updated | Practical ReadAIrr notes instead of placeholder-only page |
wiki/readarr/troubleshooting.md |
Updated | Metadata-source and search examples refreshed |
wiki/readarr/wanted.md |
Updated | Live Wanted filters/search/manual import behavior |
wiki/common/docker-guide.md |
Reviewed inherited/common | Kept as shared Docker background; ReadAIrr-specific install docs live in wiki/readarr/installation.md |
wiki/common/install-script.md |
Reviewed inherited/common | Kept as upstream community script reference, not the recommended ReadAIrr install path |
wiki/common/permissions-and-networking.md |
Reviewed inherited/common | Generic path/permission guidance remains useful |
wiki/common/useful-tools.md |
Reviewed inherited/common | Shared ecosystem links retained as inherited reference |
wiki/common/vpn.md |
Reviewed inherited/common | Generic VPN/networking guidance retained as inherited reference |
#Local layout
docs/wiki/readarr/contains Readarr-specific documentation seeds.docs/wiki/common/contains shared setup guides that the current site linked to externally.docs/api/contains the local OpenAPI documentation bundle checked againstReadAIrr/App/src/Readarr.Api.V1/openapi.jsonand current App API code. When the App bundle has not been regenerated yet, source-code-only endpoint changes are reflected here manually.
#Next iteration notes
- Replace upstream project names and paths only when the corresponding ReadAIrr behavior is confirmed in the app repo.
- Keep inherited names such as
Readarr,READARR__..., andReadarr_*where the app still requires those compatibility identifiers. - Keep attribution to the original documentation source while these pages still contain copied upstream text.
- Prefer linking to
https://readairr.com/docs/...from the app and public site. - Regenerate
ReadAIrr/App/src/Readarr.Api.V1/openapi.jsonbefore relying on the API bundle as complete source truth for newly added controllers.