docs: optimize route higtlight

[winchesHe]

Closes #

📝 Description

Before

After

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

• Documentation
  • Updated routing documentation to include useHref function for handling base path configurations in Next.js
  • Added guidance on implementing useHref in the Providers component to enhance link path flexibility

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nextui-docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 8, 2025 4:32pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 8, 2025 4:32pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2052199

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The pull request introduces modifications to the routing documentation for NextUI, specifically focusing on enhancing the NextUIProvider setup. The key change involves adding a useHref function to handle base path configurations in Next.js applications. This function prepends a base path to links using the process.env.BASE_PATH environment variable, providing more flexible routing capabilities for applications with custom base path configurations.

Changes

File	Change Summary
apps/docs/content/docs/guide/routing.mdx	Updated documentation to include useHref function implementation
app/providers.tsx	Added useHref function to dynamically construct URLs with base path

Possibly related PRs

• fix(system): missing useHref logic #2943: Addresses missing useHref logic in @nextui-org/system package
• docs: sync nextui-cli api #3035: Synchronizes NextUI CLI API documentation with potential routing file updates
• docs: add forms guide #3822: Updates routing documentation for client-side routing integration
• feat(docs): nextUI with laravel #4432: Introduces documentation for NextUI integration with Laravel

Suggested labels

📋 Scope : Docs

Suggested reviewers

• wingkwong
• jrgarciadev

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

apps/docs/content/docs/guide/routing.mdx (3)

89-89: Add validation to the base path implementation.

The useHref function implementation could benefit from additional validation to handle edge cases.

Consider adding these improvements:

// app/providers.tsx
-const useHref = (href: string) => process.env.BASE_PATH + href;
+const useHref = (href: string) => {
+  const basePath = process.env.BASE_PATH || '';
+  // Ensure href starts with forward slash
+  const normalizedHref = href.startsWith('/') ? href : `/${href}`;
+  return `${basePath}${normalizedHref}`;
+};

---

89-89: Consider adding error boundary examples.

The routing documentation would benefit from examples of error handling and error boundaries, especially for cases where navigation fails.

Would you like me to provide an example implementation of error boundaries for the routing setup?

---

89-89: Add a troubleshooting section to the documentation.

Consider adding a "Troubleshooting" section that covers common issues and their solutions, such as:

• Navigation not working in production builds
• Base path configuration issues
• Common setup mistakes

Would you like me to provide a template for the troubleshooting section?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eada8cb and 2052199.

📒 Files selected for processing (1)

• apps/docs/content/docs/guide/routing.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: TypeScript
• GitHub Check: Build