Skip to content

fix(docs): Fix strict mkdocs build failure for release workflow link#477

Merged
cursor[bot] merged 2 commits into
masterfrom
cursor/fix-docs-ci-strict-link-8d2d
Jun 22, 2026
Merged

fix(docs): Fix strict mkdocs build failure for release workflow link#477
cursor[bot] merged 2 commits into
masterfrom
cursor/fix-docs-ci-strict-link-8d2d

Conversation

@Feramance

Copy link
Copy Markdown
Owner

Problem

The Build and Deploy Documentation workflow failed on master (run #579) because mkdocs build --strict treats link validation warnings as errors:

WARNING - Doc file 'development/release-process.md' contains a relative link '../../.github/workflows/release.yml', but the target '../.github/workflows/release.yml' is not found among documentation files.
Aborted with 1 warnings in strict mode!

Fix

Replace the relative link to .github/workflows/release.yml with the canonical GitHub blob URL, matching the pattern already used elsewhere in the same document.

Verification

  • mkdocs build --strict --verbose completes successfully locally after this change.
Open in Web Open in Cursor 

cursoragent and others added 2 commits June 22, 2026 13:33
…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>
@cursor cursor Bot marked this pull request as ready for review June 22, 2026 13:41
@cursor cursor Bot merged commit 69594ac into master Jun 22, 2026
13 checks passed
@cursor cursor Bot deleted the cursor/fix-docs-ci-strict-link-8d2d branch June 22, 2026 13:42

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 --strict link 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.json churn is noisy in the diff but semantically identical; not a correctness risk.
  • Absolute GitHub URL for release.yml is slightly less convenient offline than the prior relative link, but that is a docs UX trade-off, not a production bug.
Open in Web View Automation 

Sent by Cursor Automation: qBitrr - Find critical bugs

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md relative link to .github/workflows/release.yml with 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.

Open in Web View Automation 

Sent by Cursor Automation: qBitrr PR validation triage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants