Skip to content

docs(site): fix strict-build failure — root-relative links (Pages deploy red since 07-08)#290

Merged
pilotspacex-byte merged 1 commit into
mainfrom
fix/docs-strict-root-links
Jul 12, 2026
Merged

docs(site): fix strict-build failure — root-relative links (Pages deploy red since 07-08)#290
pilotspacex-byte merged 1 commit into
mainfrom
fix/docs-strict-root-links

Conversation

@pilotspacex-byte

Copy link
Copy Markdown
Contributor

Summary

The GitHub Pages deploy has failed on every main push since 2026-07-08 (docs.yml runs mkdocs build --strict). Five links point at repo-root files outside the MkDocs docs/ tree, each a strict-mode warning → abort:

Fix: convert the 5 links to absolute GitHub blob URLs (strict mode doesn't validate external links). The published site now links to the canonical rendered files on GitHub instead of 404-ing.

Verification

Local mkdocs build --strict with the requirements-docs.txt plugin set (material, include-markdown, glightbox): zero warnings, built in 1.93s. Previously aborted with 5 warnings. Docs-only — no code paths touched; standard test/bench gates N/A.

The GitHub Pages deploy (docs.yml, mkdocs build --strict) has failed on
every main push since 2026-07-08: PR #245 added two links from
docs/guides/tuning.md to ../../BENCHMARK.md and PR #263's
docs/PRODUCTION-CONTRACT.md links ../RELEASES.md,
../.github/workflows/release.yml and ../BENCHMARK.md — all repo-root
files outside the MkDocs docs/ tree, each producing a strict-mode
warning (5 total → abort).

Convert the 5 links to absolute GitHub blob URLs, which strict mode
does not validate. Verified locally: mkdocs build --strict completes
with zero warnings (material + include-markdown + glightbox plugin
set matching requirements-docs.txt).

Docs-only; no code changes.

author: Tin Dang
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@pilotspacex-byte, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 21 seconds

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ccf69b86-3cc3-4908-ab78-1e6573593b1f

📥 Commits

Reviewing files that changed from the base of the PR and between 7a9004a and 9ab4d84.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • docs/PRODUCTION-CONTRACT.md
  • docs/guides/tuning.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-strict-root-links

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@pilotspacex-byte pilotspacex-byte merged commit 29a3480 into main Jul 12, 2026
10 checks passed
@pilotspacex-byte pilotspacex-byte deleted the fix/docs-strict-root-links branch July 12, 2026 03:03
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