Skip to content

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

@maintainerr-docs-automation

Description

@maintainerr-docs-automation

πŸ“š Docs drift report

Comparing v3.14.0 β†’ 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

  • 1780768873268-Add_Download_Client_settings.ts

Each migration typically introduces a setting or schema change. Confirm Configuration.md and Migration.md still reflect user-facing behaviour.

Rule constants

No changes to rules.constants.ts.

Public contracts (@maintainerr/contracts)

  • Added (2):
    • packages/contracts/src/settings/download-client/downloadClientSetting.ts
    • packages/contracts/src/settings/download-client/index.ts
  • Modified (1):
    • packages/contracts/src/index.ts

Public DTO changes may affect docs/API.md and the OpenAPI spec in static/openapi-spec/maintainerr_api_specs.yaml.

New HTTP controllers

  • apps/server/src/modules/api/download-client-api/download-client-api.controller.ts

New controllers almost always mean new routes β€” check docs/API.md and the OpenAPI spec.

feat: commits on this branch

  • 8a8b26e1 feat: download client cleanup for Radarr/Sonarr deletions (qBittorrent) (#3054)

Behavioral fixes worth reviewing

  • c4e8ea00 fix(plex): use /identity for the connection probe and v2 resources for server discovery (#3063)
    • touched: apps/server/src/modules/api/lib/plexApi.ts, apps/server/src/modules/api/lib/plextvApi.spec.ts, apps/server/src/modules/api/lib/plextvApi.ts, apps/server/src/modules/api/plex-api/plex-api.service.spec.ts, apps/server/src/modules/api/plex-api/plex-api.service.ts, apps/ui/src/components/Settings/Plex/index.tsx
  • b10ea8d9 fix(overlay): uniform style scaling, rotation offset, and font register logging (fixes #3025) (#3057)
    • touched: apps/server/src/modules/overlays/overlay-render.service.spec.ts, apps/server/src/modules/overlays/overlay-render.service.ts
  • e1c034ca fix(metadata): keep media-server ids unless corroborated; accept on provider year agreement (#3011)
    • touched: apps/server/src/modules/metadata/metadata.service.spec.ts, apps/server/src/modules/metadata/metadata.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.

πŸ€– Documentation-labeled issues resolved by merged PRs

No merged PRs resolving documentation-labeled issues in this range.

πŸ€– 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