Skip to content

Docs drift - updates needed for the next Maintainerr releaseΒ #173

Closed

Description

@maintainerr-docs-automation

πŸ“š Docs drift report

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

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

  • e6919f5b feat(collections): rescan the item's folder after an *arr delete (#3720)

Behavioral fixes worth reviewing

  • a5427774 fix(collections): run one size sweep per collection, not one per removed item (#3718)
    • touched: 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.

πŸ€– 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions