Skip to content

fix: sdk doc link path#1014

Merged
amhsirak merged 1 commit into
developfrom
doc-sdk
Mar 24, 2026
Merged

fix: sdk doc link path#1014
amhsirak merged 1 commit into
developfrom
doc-sdk

Conversation

@RohitR311
Copy link
Copy Markdown
Collaborator

@RohitR311 RohitR311 commented Mar 24, 2026

What this PR does?

The SDK section was pointing to the wrong doc link. This PR fixes it.

Summary by CodeRabbit

  • Documentation
    • SDK documentation links have been updated to reference the new documentation structure, ensuring users can access the latest SDK resources.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7a9cacb3-1fff-486f-82a9-16d919cbbd4a

📥 Commits

Reviewing files that changed from the base of the PR and between d0e3048 and f929799.

📒 Files selected for processing (2)
  • README.md
  • src/components/dashboard/MainMenu.tsx

Walkthrough

The PR updates SDK documentation links in two files from a specific page URL (/sdk/sdk-overview) to a category-based URL (/category/sdk). This involves straightforward URL string updates in README.md and the MainMenu.tsx component with no functional or logic changes.

Changes

Cohort / File(s) Summary
Documentation Link Updates
README.md, src/components/dashboard/MainMenu.tsx
Updated SDK documentation links from https://docs.maxun.dev/sdk/sdk-overview to https://docs.maxun.dev/category/sdk across both files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

Scope: Documentation

Poem

🐰 A link once pointed to /sdk/sdk-overview,
Now it hops to /category/sdk with cheer,
Two files updated, the path made clean,
Simpler docs, as ever they've been!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating incorrect SDK documentation links in both README.md and MainMenu.tsx components.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc-sdk

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.

@amhsirak amhsirak merged commit e6ad87e into develop Mar 24, 2026
1 check passed
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