Docs drift - updates needed for the next Maintainerr release #171

📚 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): 216
• Documented keys (docs/Glossary.md): 216

Glossary is in sync with the code.

New migrations on this branch

• 1789161267512-MakeDownloadClientTypeNullable.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)

• Modified (2):
  • packages/contracts/src/settings/download-client/downloadClientSetting.ts
  • packages/contracts/src/settings/settings.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

• 3486b520 fix(settings): read no download client as null instead of qBittorrent (#3714)
  • touched: apps/server/src/modules/settings/dto's/setting.dto.ts, apps/server/src/modules/settings/entities/settings.entities.ts, apps/server/src/modules/settings/settings-data.service.ts, apps/server/src/modules/settings/settings-operations.service.ts, apps/server/src/modules/settings/settings.controller.ts, apps/ui/src/api/settings.ts, apps/ui/src/components/Settings/DownloadClient/index.spec.tsx, apps/ui/src/components/Settings/DownloadClient/index.tsx, apps/ui/src/locales/cs.po, apps/ui/src/locales/da.po, apps/ui/src/locales/de.po, apps/ui/src/locales/en.po, apps/ui/src/locales/es.po, apps/ui/src/locales/fi.po, apps/ui/src/locales/fr.po, apps/ui/src/locales/it.po, apps/ui/src/locales/nb.po, apps/ui/src/locales/nl.po, apps/ui/src/locales/pl.po, apps/ui/src/locales/pt.po, apps/ui/src/locales/sv.po
• e4e1a64b fix(ui): clear the download client URL when the client type changes
  • touched: apps/ui/src/components/Settings/DownloadClient/index.spec.tsx, apps/ui/src/components/Settings/DownloadClient/index.tsx

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.