-
Notifications
You must be signed in to change notification settings - Fork 457
fix sdk linking issues #783
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR addresses broken links in the SDK documentation by making two key changes:
- Removes the './' prefix from href links in the SDK documentation navigation structure (docs/templates/sdk/index.mdx)
- Implements proper URL path handling in the SDK overview component (docs/src/components/sdk/overview.tsx) by adding platform-aware path construction
The changes ensure that SDK documentation links work correctly across different platforms (next, react, js, python) by maintaining proper URL paths and platform context. The solution involves using next/navigation's usePathname hook and implementing a buildSDKUrl utility function that constructs absolute URLs with the correct platform context.
Confidence score: 5/5
- This PR is very safe to merge as it only affects documentation link paths and URL construction
- The changes are focused, well-structured, and follow a consistent pattern across all documentation sections
- Key files that need attention:
- docs/templates/sdk/index.mdx - Verify all link paths are correctly updated
- docs/src/components/sdk/overview.tsx - Review URL construction logic
2 files reviewed, 2 comments
✨ No issues found! Your code is sparkling clean! ✨ 🗒️ View all ignored comments in this repo
Need help? Join our Discord for support! |
This fixes the broken links on the SDK pages.
Important
Fixes broken SDK links by ensuring URLs are absolute in
overview.tsx
andindex.mdx
.overview.tsx
.buildSDKUrl
function inSDKOverview
to construct absolute URLs usinggetPlatformUrl
.href
inLink
components inoverview.tsx
to usebuildSDKUrl
.href
insdkSections
inindex.mdx
to make paths absolute.This description was created by
for 242e369. You can customize this summary. It will automatically update as commits are pushed.