Skip to content

Fix links in Get Started section of index.mdx#332

Open
nicoschtein wants to merge 1 commit intojamiepine:mainfrom
nicoschtein:patch-1
Open

Fix links in Get Started section of index.mdx#332
nicoschtein wants to merge 1 commit intojamiepine:mainfrom
nicoschtein:patch-1

Conversation

@nicoschtein
Copy link

@nicoschtein nicoschtein commented Mar 20, 2026

Updated links in the Get Started section for correct paths.

Summary by CodeRabbit

  • Documentation
    • Updated navigation links in "Get Started" documentation to correctly point to installation, quick start, and API reference resources.

Updated links in the Get Started section for correct paths.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a8dd4ab9-9ce4-459d-9e12-b8f3659dfd7e

📥 Commits

Reviewing files that changed from the base of the PR and between d70b878 and 8b796bc.

📒 Files selected for processing (1)
  • docs/content/docs/index.mdx

📝 Walkthrough

Walkthrough

Navigation links in the Get Started section of the documentation index are updated to point to new route paths. The Installation, Quick Start, and API Reference links are modified to use /overview/... and /api-reference routes instead of previous /docs/... paths.

Changes

Cohort / File(s) Summary
Documentation Navigation
docs/content/docs/index.mdx
Updated href targets for Installation, Quick Start, and API Reference links from /docs/... routes to /overview/... and /api-reference routes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Through docs we hop with links anew,
From /docs/ paths to routes we flew,
/overview/ and /api-reference clear,
Navigation's path is now quite dear,
A rabbit's leap to better land! 🌟

🚥 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 clearly describes the main change: fixing navigation links in the Get Started section of index.mdx, which directly corresponds to the changeset.
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 unit tests (beta)
  • Create PR with unit tests

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.

Tip

You can validate your CodeRabbit configuration file in your editor.

If your editor has YAML language server, you can enable auto-completion and validation by adding # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json at the top of your CodeRabbit configuration file.

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.

1 participant