docs: fix SDK root 404, breadcrumb link, callout icons#401
Merged
Conversation
Untyped callouts rendered with default (neutral) styling instead of the info variant, so their icon/border differed from every other info callout.
/python (and /node, /java) had no page and 404'd; send them to getting-started/installation like the section landing already does.
The SDK breadcrumb (e.g. Python) only redirected to the first doc; render it as a plain label instead of a link.
📝 WalkthroughWalkthroughThe documentation updates add SDK root redirects, render SDK roots as non-link breadcrumb labels, style those labels, and explicitly mark four callouts as informational. ChangesSDK navigation
Documentation callout types
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/app/routes/docs.$.tsx (1)
27-29: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUpdate the stale breadcrumb JSDoc.
The comment at Line 16 says the leading segment links to its section index, but SDK roots are now intentionally rendered as non-links. Update it to document this exception.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/app/routes/docs`.$.tsx around lines 27 - 29, Update the breadcrumb JSDoc describing the leading segment so it accurately states that it links to its section index except for SDK roots, which are rendered as plain non-links and redirect to the first document. Keep the implementation in the breadcrumb mapping unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/app/routes/docs`.$.tsx:
- Around line 27-29: Update the breadcrumb JSDoc describing the leading segment
so it accurately states that it links to its section index except for SDK roots,
which are rendered as plain non-links and redirect to the first document. Keep
the implementation in the breadcrumb mapping unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 89c03696-de11-48f8-bd3d-960b8ff75103
📒 Files selected for processing (7)
docs/app/lib/redirects.tsdocs/app/routes/docs.$.tsxdocs/app/styles/docs.cssdocs/content/docs/architecture/storage.mdxdocs/content/docs/java/guides/operations/sso.mdxdocs/content/docs/python/getting-started/installation.mdxdocs/content/docs/python/guides/dashboard/sso.mdx
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.
Three docs-site fixes reported after #400.
Bare SDK root 404'd
Visiting `/python` (and `/node`, `/java`) hit Page not found — the SDK root has no page of its own, and only the `/{sdk}/getting-started` section landing was in the redirect map. Added the bare SDK root to the same landing map, so it redirects to `getting-started/installation`. Verified in the prerendered stub (`build/client/python/index.html` meta-refreshes to the installation page).
SDK breadcrumb was a dead link
The leading breadcrumb crumb (e.g. Python) linked to that same redirect-only SDK root. It now renders as a plain label — the rest of the trail stays clickable.
Inconsistent callout icons
Four callouts omitted `type=`, so they fell back to the neutral default variant and their icon/border differed from every other info callout (191 use `type="info"`). Set `type="info"` on all four (
installation, twossopages,architecture/storage).Verification
Summary by CodeRabbit
New Features
Documentation