fix(cloud-mcp): correct the component in the how-to-use-these-docs xref - #669
Open
JakeSCahill wants to merge 1 commit into
Open
fix(cloud-mcp): correct the component in the how-to-use-these-docs xref#669JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
The xref named the component `data-platform`, which does not exist; the cloud docs component is `cloud-data-platform` and this page lives in the `home` component. Antora could not resolve it, so the docs build logged "target of xref not found: data-platform:ROOT:how-to-use-these-docs.adoc" at ERROR level and the link rendered as unresolved text for readers. Unlike a stale URL that the site redirects, there is nothing here for a reader to follow. The page is published at https://docs.redpanda.com/home/how-to-use-these-docs/ (verified 200), so the correct target is home:ROOT. modules/ROOT/nav.adoc already xrefs the home component this way. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe read-only Redpanda documentation MCP server reference now uses the Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
modules/develop/pages/cloud-mcp/overview.adoc:73xrefsdata-platform:ROOT:how-to-use-these-docs.adoc. There is nodata-platformcomponent — the cloud docs component iscloud-data-platform, and this particular page lives in thehomecomponent.Unlike a stale URL that the site 301s, there is nothing here for a reader to follow: Antora cannot resolve the target, so it renders as unresolved text and the build logs an error:
Fix: point it at
home:ROOT:how-to-use-these-docs.adoc. Verifiedhttps://docs.redpanda.com/home/how-to-use-these-docs/returns 200, andmodules/ROOT/nav.adocalready references thehomecomponent the same way. This is the onlyxref:data-platform:in the repo.Found while chasing warnings in a docs-site preview build.
🤖 Generated with Claude Code