Skip to content

docs: bring README, roadmap and wiki up to date for v1.37.0 - #2660

Merged
vavallee merged 1 commit into
mainfrom
docs/feature-audit-2026-09
Sep 19, 2026
Merged

vavallee merged 1 commit into
mainfrom
docs/feature-audit-2026-09

Conversation

@vavallee

@vavallee vavallee commented Sep 17, 2026

Copy link
Copy Markdown
Owner

Summary

Audit of the user facing docs against what has shipped, rebased onto main and refreshed for everything merged since the first push: the download client path doctor, unattended release discovery, library adoption, the requester role and the grouped navigation. Those five landed with their own doc updates, so most of what was left here was correcting sentences they made false and covering what nobody had claimed yet.

Docs only, so there is no changelog fragment. Nothing describes an unreleased fragment as released beyond what main already says in the same words, and the lines open PRs #2391, #2480, #2606, #2607, #2615, #2633, #2673 and #2678 touch were left alone.

File What changed How verified
README.md Comparison table status now v1.37.x the release this PR lands before; CHANGELOG top section is v1.36.2 plus the fragments in changelog.d/
README.md Footnote notes Livrarr is now at v0.1.0-alpha6 gh api repos/kkodecs/livrarr/releases
README.md Features: manual metadata editing with field locks, Fix match internal/models/book.go (LockedFields), web/src/components/EditBookModal.tsx, bookDetail.fixMatch in en.json
README.md Features: daily query limit, rate limit hold ladder, stopped indexer flag, freeleech only hold internal/indexer/cooldown.go (cooldownLadder), internal/models/indexer.go, web/src/pages/settings/IndexersTab.tsx
README.md The Import page's two views replace the old "Manual Import plus bulk folder import in Settings" bullet web/src/pages/import/ImportPage.tsx, FolderImportLink in web/src/pages/settings/ImportTab.tsx
README.md Features: log download, update badge, db-check and db-repair web/src/pages/settings/LogsTab.download.test.tsx, updateAvailable in en.json, cmd/bindery/dbcheck.go
README.md UI: the five entry top bar with its groups and tab strips web/src/components/navGroups.ts, web/src/App.tsx
README.md UI: header library search and the single Add to library dialog internal/api/library_search.go, LibrarySearch.tsx (rendered in the header at App.tsx:203), AddToLibraryModal.tsx
README.md Integrations table: metadata sources, import lists, library tools rows internal/metadata/*, the /importlist routes and internal/hardcoverlistsyncer, internal/calibre, internal/abs, internal/grimmory, import.drop_folder
README.md Documentation table links docs/search-design.md; Discord #changelog to #releases the file exists and was unlinked; the server's live channel list
docs/ROADMAP.md Now: the six items it listed moved to Delivered (v1.31.0); the unattended discovery item main added stays issues #1956, #1957, #1958, #1885, #1854, #1848, #1816, #1815, #1618, #1903, #1720 closed as completed; internal/importer/audiotag.go, scanner_poll.go, internal/hardcoverlistsyncer/syncer.go, internal/api/authors.go, internal/downloader/rtorrent, GeneralTab.tsx
docs/ROADMAP.md Next up: Manual Import wizard, unmatched file book creation, bulk folder import, the unified add flow and the shared book folder moved to Delivered; #1430, #1357 and #1632 stay web/src/pages/import/* (#1719), internal/api/library_search.go, internal/importer/renamer.go (#1959); those three issues still open
docs/ROADMAP.md Next up: language item trimmed to what is left (filtering) language is editable in EditBookModal.tsx and internal/api/books.go:482; no language filter in BooksPage.tsx
docs/API.md New Series block with the opt in pagination of GET /series cmd/bindery/series_routes.go, List in internal/api/series.go:187
docs/API.md monitorNewItems on POST /author internal/api/authors.go:515 and models.IsAuthorMonitorNewItemsValid
docs/API.md Response only cooldownUntil and cooldownReason on indexers internal/models/indexer.go:80, withCooldown in internal/api/indexers.go
docs/User-Guide-Wiki.md metadata.opf sidecar setting in the after import paragraph import.write_opf_sidecar in GeneralTab.tsx:337
docs/User-Guide-Wiki.md The auto grab switch paragraph now says a bulk Search refuses and that a single book's Search Indexers still runs changelog.d/2669-manual-search-silent.md behaviour confirmed against the search chokepoint; the paragraph previously told you to grab by hand from the Wanted page, which bulk Search no longer does
docs/User-Guide-Wiki.md Rule 4 now says an ebook is titled from its own filename with the book folder as the fallback, and that audiobooks keep the folder scanTitle in internal/importer/layout_title.go:129
docs/Migrating-From-Readarr-Wiki.md Same correction: the page said a file is matched on the folder names and the filename convention does not matter scanTitle in internal/importer/layout_title.go:129
docs/QUICKSTART.md "Authors, Add Author" is now "Library, Authors" navGroupsFor in web/src/components/navGroups.ts, authors.addAuthor in en.json
docs/Hardcover-Series-Wiki.md "Open Series" is now "Open Library, Series" same
docs/DEPLOYMENT.md The per client path remap section points at Diagnose internal/api/download_client_diagnose.go (checkDiagClientPath, diagCodeRemap)

Dropped as no longer needed

  • A "nothing is parked here" line under Now: main added the unattended discovery item there, so the section is not empty.
  • Nothing else was dropped. The README bullet about Manual Import was rewritten rather than removed.

🤖 Generated with Claude Code

https://claude.ai/code/session_016fJcCVbNnKsmj2MAAMwWj9

@codecov

codecov Bot commented Sep 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

README: the comparison table said Active (v1.22.x); the Features list and
the integrations table were missing manual import, field locks and Fix
match, the indexer query limit and rate limit hold, the header library
search, log download, the update badge and the db-check commands. The
Discord channel is named #releases now. The grouped top bar and the two
views of the Import page replace the flat nav and the folder scan that
used to live in Settings.

ROADMAP: everything the Now section listed shipped in v1.31.0, and most
of the Manual Import and add flow items under Next up shipped between
v1.28.0 and v1.36.0. They move to Delivered; unattended discovery and
the items still open stay where they are.

API.md gains a Series block with its opt in pagination, monitorNewItems
on POST /author, and the response only cooldownUntil and cooldownReason
on indexers. The user guide gains the metadata.opf sidecar, says that a
bulk Search refuses while automatic grabbing is off, and records that an
ebook is titled from its own filename with the book folder as fallback;
the Readarr migration page said the opposite. DEPLOYMENT points the path
remap section at Diagnose.

Docs only, each claim checked against the code.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016fJcCVbNnKsmj2MAAMwWj9
Signed-off-by: vavallee <vavallee@protonmail.com>
@vavallee
vavallee force-pushed the docs/feature-audit-2026-09 branch from 582e238 to e33e4e5 Compare September 19, 2026 01:53
@vavallee vavallee changed the title docs: bring README, roadmap and wiki up to date with v1.36.2 docs: bring README, roadmap and wiki up to date for v1.37.0 Sep 19, 2026
@vavallee
vavallee marked this pull request as ready for review September 19, 2026 02:18
@vavallee
vavallee merged commit fa90ffc into main Sep 19, 2026
28 checks passed

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only, already merged. Spot-checked the cited code references:

  • scanTitle at internal/importer/layout_title.go:130 — exists, matches the updated title-sourcing description in User-Guide-Wiki.md and Migrating-From-Readarr-Wiki.md.
  • monitorNewItems on POST /author (internal/api/authors.go:524) and the 400 guard (line 1025) — confirmed; API.md description is accurate.
  • Series pagination at internal/api/series.go:194 — the opt-in limit/offset envelope is documented correctly.
  • docs/search-design.md and docs/Metadata-Editing-Wiki.md — both files exist; links in README are valid.

No code changes, no security surface. Nothing to flag.

— 🤖 Bindery triage bot (automated). Reply to correct me; a human will see it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant