Skip to content

Docs drift β€” updates needed for the next Maintainerr releaseΒ #98

@maintainerr-docs-automation

Description

@maintainerr-docs-automation

πŸ“š 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): 163
  • Documented keys (docs/Glossary.md): 163

Glossary is in sync with the code.

New migrations on this branch

No new migrations.

Rule constants

No changes to rules.constants.ts.

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

No feat: commits detected.

Behavioral fixes worth reviewing

  • 8a4c7635 fix(rules): sw_lastWatched returns null for never-watched shows on Plex (#3083) (#3102)
    • touched: apps/server/src/modules/rules/getter/plex-getter.service.spec.ts, apps/server/src/modules/rules/getter/plex-getter.service.ts
  • f5c78571 fix(metadata): resolve movie/show ids from the item, not its parent (#3065) (#3100)
    • touched: apps/server/src/modules/metadata/metadata.service.spec.ts, apps/server/src/modules/metadata/metadata.service.ts
  • 5bf7bbab fix(radarr): only swallow the "already excluded" exclusion 400 (#3084) (#3099)
    • touched: apps/server/src/modules/api/servarr-api/helpers/radarr.helper.spec.ts, apps/server/src/modules/api/servarr-api/helpers/radarr.helper.ts
  • 7c9310a0 fix(collections): skip remote create for empty collections (Emby) (#3075) (#3098)
    • touched: apps/server/src/modules/collections/collections.service.spec.ts, apps/server/src/modules/collections/collections.service.ts
  • 179215b2 fix(emby): create collections with an initial item to avoid HTTP 500 (#3075) (#3097)
    • touched: 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/collections/collections.service.ts
  • d4b0dac8 fix(radarr): treat already-excluded 400 as success when adding import-list exclusions (#3084) (#3096)
    • touched: apps/server/src/modules/api/external-api/external-api.service.ts, apps/server/src/modules/api/servarr-api/helpers/radarr.helper.spec.ts, apps/server/src/modules/api/servarr-api/helpers/radarr.helper.ts
  • 1ec9bb47 fix(collections): self-heal empty Plex collections that reject every add (#3094)
    • 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/collections/collections.service.spec.ts, apps/server/src/modules/collections/collections.service.ts

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).
    Clone Maintainerr/Maintainerr and Maintainerr/Maintainerr_docs before 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 main branch 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/ and static/openapi-spec/.
    Do not touch sidebars, config, or unrelated assets unless strictly required by a doc edit.
  • PR description structure:
    1. What was added β€” one short bullet per doc edit, citing the upstream commit or PR.
    2. 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.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions