Skip to content

Fix broken links and warnings in docs build - #1910

Merged
aantn merged 4 commits into
masterfrom
claude/fix-docs-build-OiAAr
Apr 15, 2026
Merged

aantn merged 4 commits into
masterfrom
claude/fix-docs-build-OiAAr

Conversation

@aantn

@aantn aantn commented Apr 14, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Replace broken CLAUDE.md relative link with absolute GitHub URL in operator dev docs (target is outside docs build)
  • Update two links pointing to excluded permissions.md to target the actual content in kubernetes.md#adding-permissions-for-additional-resources-in-cluster-deployments
  • Fix anchor link for "Fast Mode & Prompt Controls" section in HTTP API docs (#fast-mode--prompt-controls → #fast-mode-prompt-controls)

Test plan

  • Ran mkdocs build — all previous warnings are resolved
  • Verify links render correctly on the built docs site

https://claude.ai/code/session_01YYysj7aWaSeyda42SHeyWD

- Fix relative link to latest benchmark results in latest-results.md
- Replace broken CLAUDE.md relative link with absolute GitHub URL in operator/development.md
- Update permissions.md links to point to kubernetes.md (permissions.md is excluded from build)
- Fix anchor link for Fast Mode & Prompt Controls in http-api.md

https://claude.ai/code/session_01YYysj7aWaSeyda42SHeyWD
Signed-off-by: Claude <noreply@anthropic.com>

@claude claude 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.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@coderabbitai

coderabbitai Bot commented Apr 14, 2026 •

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation link corrections and updates across multiple files. Changes include path normalization for relative references, anchor adjustments for documentation anchors, and reorganization of cross-references to point to more specific documentation sections.

Changes

Cohort / File(s) Summary
Documentation Path Corrections
docs/development/evaluations/latest-results.md
Updated client-side redirect and fallback hyperlink paths from parent-relative (../history/...) to same-directory (history/...) references.
Documentation Reference Updates
docs/operator/development.md, docs/reference/kubernetes-permissions.md
Replaced relative paths with absolute GitHub URL for contribution guidelines and reorganized cross-references to point to Kubernetes-specific documentation instead of generic permissions page.
Anchor Reference Fix
docs/reference/http-api.md
Corrected documentation anchor reference from #fast-mode--prompt-controls to #fast-mode-prompt-controls in behavior_controls field description.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • arikalon1
  • Sheeproid
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix broken links and warnings in docs build' clearly and concisely summarizes the main objective of the pull request—fixing documentation links and build warnings across multiple files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@netlify

netlify Bot commented Apr 14, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for holmes-docs ready!

Name Link
🔨 Latest commit 7113a36
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69df8087f544c40008e9ec89
😎 Deploy Preview https://deploy-preview-1910--holmes-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai coderabbitai 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.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/development/evaluations/latest-results.md`:
- Line 6: Update the JavaScript redirect assignment to set window.location.href
to the correct sibling path "../history/results_20260329_033817/" (replacing the
non-existent "history/results_20260405_043024/") and make the same change to the
other redirect occurrence in this file so both redirects point to
"../history/results_20260329_033817/".

In `@docs/operator/development.md`:
- Line 344: Replace the absolute GitHub URL for the CLAUDE.md link with the
repository-relative link used elsewhere: change the href
"https://github.com/HolmesGPT/holmesgpt/blob/master/CLAUDE.md" to the relative
path "../../CLAUDE.md" in the docs/operator/development.md link so the internal
documentation remains consistent, works offline, and follows MkDocs
branch-agnostic linking.

In `@docs/reference/http-api.md`:
- Line 63: The table's anchor link `#fast-mode-prompt-controls` is invalid; find
the actual heading that describes fast mode/prompt controls (search for headings
like "Fast Mode & Prompt Controls" or variants) and either update the table
entry for `behavior_controls` to use the correct fragment slug for that heading
or rename the heading to exactly match `Fast Mode & Prompt Controls` so the
generated slug becomes `#fast-mode-prompt-controls`; ensure the link text
remains descriptive and the fragment matches the heading slug generation rules
used by the markdown renderer.

In `@docs/reference/kubernetes-permissions.md`:
- Line 61: Replace the abbreviated link display text "Adding Permissions for
Additional Resources" with the full heading text "Adding Permissions for
Additional Resources (In-Cluster Deployments)" for the link that targets the
anchor
docs/data-sources/builtin-toolsets/kubernetes.md#adding-permissions-for-additional-resources-in-cluster-deployments;
update both occurrences (the links on lines referencing that anchor, currently
showing the short text) so the displayed link exactly matches the target
heading, or explicitly confirm the abbreviation is intentional if you prefer to
keep it.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0b9f92c5-9ad5-46bb-82a3-cdb0031ca04f

📥 Commits

Reviewing files that changed from the base of the PR and between 3aa0f37 and ecff637.

📒 Files selected for processing (4)
  • docs/development/evaluations/latest-results.md
  • docs/operator/development.md
  • docs/reference/http-api.md
  • docs/reference/kubernetes-permissions.md

Comment thread docs/development/evaluations/latest-results.md Outdated
Comment thread docs/operator/development.md
Comment thread docs/reference/http-api.md
Comment thread docs/reference/kubernetes-permissions.md
@aantn aantn changed the title Fix documentation links and anchors Fix broken links and warnings in docs build Apr 14, 2026
@aantn
aantn enabled auto-merge (squash) April 15, 2026 12:11
https://claude.ai/code/session_01YYysj7aWaSeyda42SHeyWD
Signed-off-by: Claude <noreply@anthropic.com>
@aantn
aantn merged commit 784eb0f into master Apr 15, 2026
15 of 16 checks passed
@aantn
aantn deleted the claude/fix-docs-build-OiAAr branch April 15, 2026 12:26
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.

4 participants