fix(docs): Fix strict mkdocs build failure for release workflow link#477
Conversation
…build MkDocs --strict fails when release-process.md links to ../../.github/workflows/release.yml because that path is outside the docs tree. Use the canonical GitHub blob URL instead. Co-authored-by: Feramance <Feramance@users.noreply.github.com>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Bug Scan Summary
Date: 2026-06-22
Commits inspected: 13199dea..f280d7f1 (2 commits: docs link fix + pre-commit.ci lockfile reorder)
Result: No critical bugs found.
Scope reviewed
docs/development/release-process.md— relative workflow link replaced with canonical GitHub blob URL for MkDocs--strictlink validation. Documentation-only; no runtime code paths.webui/package-lock.json— pre-commit.ci key reordering only. Verified 0 package version diffs between base and head (387 packages, identical resolved versions/integrity).
Deduplication check
- Open PRs searched:
mkdocs release-process,package-lock— no overlapping fixes. - Recently merged PRs (14d): #468–#477 reviewed; no duplicate fix for this change class.
- Open issues searched:
mkdocs strict— none.
Notes (below confidence bar)
- The
package-lock.jsonchurn is noisy in the diff but semantically identical; not a correctness risk. - Absolute GitHub URL for
release.ymlis slightly less convenient offline than the prior relative link, but that is a docs UX trade-off, not a production bug.
Sent by Cursor Automation: qBitrr - Find critical bugs
There was a problem hiding this comment.
PR Review (Cursor Automation)
Verdict: MERGE
Rationale: The strict-MkDocs broken workflow link is fixed, validation is green, and no application/concurrency surfaces are touched.
Master Gaps
- Addressed by this PR: replaces the
docs/development/release-process.mdrelative link to.github/workflows/release.ymlwith a canonical GitHub URL that MkDocs strict mode accepts. - Remaining / not addressed: none identified.
Rubric
| Gate | Score | Notes |
|---|---|---|
| Correctness | Pass | The new URL points to the intended release workflow and avoids MkDocs treating the target as a missing in-docs relative file. |
| Completeness | Pass | Covers the documented CI failure in the PR body; no other broken release workflow links found in the changed document. |
| Concurrency | N/A | Documentation/lockfile formatting only; no qBitrr/arss.py, qBittorrent, Arr worker, or Peewee/SQLite logic touched. |
| Tests | Pass | Author reports mkdocs build --strict --verbose; GitHub documentation build and link check are green. No pytest output expected for this repo. |
| CI hygiene | Pass | pre-commit.ci, CodeQL, documentation build/link checks, and PR Docker image builds are green; skipped automerge/package/deploy jobs are not failures. |
| Diff hygiene | Pass | Scoped to the docs link plus webui/package-lock.json JSON key reordering from the configured pre-commit formatter; parsed lockfile content is semantically unchanged and no temporary markdown artifacts were found. |
CI Summary
Pass — no failing required checks. Green checks include pre-commit, CodeQL actions/javascript-typescript/python, Build documentation, Check documentation links, and Docker image builds for amd64/arm64.
Duplicate Check
None.
Notes
PR #477 is already merged at the time of this review; no follow-up rework is required.
Sent by Cursor Automation: qBitrr PR validation triage


Problem
The Build and Deploy Documentation workflow failed on
master(run #579) becausemkdocs build --stricttreats link validation warnings as errors:Fix
Replace the relative link to
.github/workflows/release.ymlwith the canonical GitHub blob URL, matching the pattern already used elsewhere in the same document.Verification
mkdocs build --strict --verbosecompletes successfully locally after this change.