Repository navigation
Docs drift - updates needed for the next Maintainerr releaseΒ #187
Copy link
Copy link
Closed
Description
π Docs drift report
Comparing origin/main β HEAD against Maintainerr_docs. Informational only - maintainers decide what needs doc updates before release.
Rule glossary parity
- Code rule keys (
rules.constants.ts): 225 - Documented keys (
docs/Glossary.md): 223
In code but missing from Glossary (2)
Seerr.watchlist_isListedByUsersSeerr.watchlist_isWatchlisted
New migrations on this branch
No new migrations.
Rule constants
rules.constants.tschanged: +16 / -0 lines- Review rule tables in
docs/Rules.mdxand entries indocs/Glossary.md.
Public contracts (@maintainerr/contracts)
- Modified (1):
packages/contracts/src/media-server/types.ts
Public DTO changes may affect docs/API.md and the OpenAPI spec in static/openapi-spec/maintainerr_api_specs.yaml.
New HTTP controllers
No new controllers.
feat: commits on this branch
- 8aea3c34 feat(rules): add Seerr watchlist rules (#3975)
Behavioral fixes worth reviewing
- d552f73f fix: ship patched Alpine packages and remove flagged dependencies (#3983)
- touched:
apps/server/src/modules/api/github-api/github-api.service.spec.ts,apps/server/src/modules/api/github-api/github-api.service.ts
- touched:
- be300a7d fix(sonarr): match an episode by its file before its numbers or TVDB id (#3897)
- touched:
apps/server/src/modules/actions/sonarr-action-handler.spec.ts,apps/server/src/modules/actions/sonarr-action-handler.ts,apps/server/src/modules/api/media-server/emby/emby-adapter.service.spec.ts,apps/server/src/modules/api/media-server/emby/emby-adapter.service.ts,apps/server/src/modules/api/media-server/jellyfin/jellyfin-adapter.service.spec.ts,apps/server/src/modules/api/media-server/jellyfin/jellyfin-adapter.service.ts,apps/server/src/modules/api/media-server/plex/plex.mapper.spec.ts,apps/server/src/modules/api/media-server/plex/plex.mapper.ts,apps/server/src/modules/api/servarr-api/helpers/sonarr.helper.spec.ts,apps/server/src/modules/api/servarr-api/helpers/sonarr.helper.ts,apps/server/src/modules/rules/getter/sonarr-getter.service.spec.ts,apps/server/src/modules/rules/getter/sonarr-getter.service.ts
- touched:
- 7aefa7d6 fix(plex): avoid metadata augmentation during rule evaluation (#3977)
- touched:
apps/server/src/modules/api/plex-api/plex-api.service.spec.ts,apps/server/src/modules/api/plex-api/plex-api.service.ts,apps/server/src/modules/rules/getter/plex-getter.service.spec.ts,apps/server/src/modules/rules/getter/plex-getter.service.ts
- touched:
- ebc2875a fix(tvdb): log in again after a failed login (#3964)
- touched:
apps/server/src/modules/api/tvdb-api/tvdb.service.spec.ts,apps/server/src/modules/api/tvdb-api/tvdb.service.ts
- touched:
- 056f8778 fix(tvdb): start while TVDB is unreachable (#3963)
- touched:
apps/server/src/modules/api/tvdb-api/tvdb.service.spec.ts,apps/server/src/modules/api/tvdb-api/tvdb.service.ts
- touched:
fix: commits that touched a doc-worthy surface - the UI, any server module except internal-only events/logging, any controller, or the README. Worth scanning to decide whether observable behavior changed enough to warrant a docs note.
Documentation-labeled issues & PRs
No open issues or in-range merged PRs carry the documentation label.
π€ Guidance for Copilot opening the docs PR
Open a PR on Maintainerr_docs that addresses this drift report, following these rules:
- Always work from local clones, not github.com web views (they can be cached or truncated).
CloneMaintainerr/MaintainerrandMaintainerr/Maintainerr_docsbefore anything else. - Read complete files, not excerpts or partial reads. Coverage you would otherwise miss often
sits past the first screenful - read each doc file and each commit diff end-to-end. - Source of truth: the upstream Maintainerr commits and file diffs listed above.
Use the prose summary as guidance, but always confirm against the local clone
(git show <sha>) before editing. - Skip what's already documented: read the current
mainbranch of Maintainerr_docs
and the most recent merged docs PRs first. If something is already covered, do not
re-document it. - Minimal edits only: make only the doc updates that are still missing for the Next
release. No speculative additions, no broad rewrites. - Doc-only changes: restrict edits to files under
docs/andstatic/openapi-spec/.
Do not touch sidebars, config, or unrelated assets unless strictly required by a doc edit. - PR description structure:
- What was added - one short bullet per doc edit, citing the upstream commit or PR.
- Already covered by prior PRs - list anything from this drift that earlier merged
docs PRs already documented, so reviewers can confirm it's intentionally skipped.
- Keep the PR focused and tied to the actual code diff rather than the issue summary alone.
Reacted by Copilot
Activity