feat(docs): added tanstack router to the routing section in the documentation

[kuri-sun]

Closes #

📝 Description

Add TanStack router to the routers documentation

⛳️ Current behavior (updates)

No TanStack router in the doc

🚀 New behavior

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

No

📝 Additional Information

Summary by CodeRabbit

• New Features

  • Added a section in the documentation for integrating TanStack Router with NextUI, including practical examples for routing management and URL building.

• Documentation

  • Improved clarity and usability of routing setup instructions for developers using TanStack Router and NextUI.

[linear[bot]]

ENG-818 Add TanStack to the Routers Docs

[vercel[bot]]

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	Aug 29, 2024 3:44pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 29, 2024 3:44pm

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: e48c64ccfc7c2df469d60e96dbfaa6f3c8d08ee3

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[bot]]

Walkthrough

This update introduces a new section in the documentation that details the integration of the TanStack Router with NextUI. It provides practical examples for implementing the NextUIProvider in a root route and describes the use of the navigate and useHref props for routing and URL management. Additionally, it includes guidance on configuring TypeScript for autocompletion with the href prop, enhancing the clarity and usability of the routing setup for developers.

Changes

File Path	Change Summary
apps/docs/content/docs/guide/routing.mdx	Added a new section on integrating TanStack Router with NextUI, including usage examples and TypeScript configuration for href.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Router
    participant Provider

    User->>App: Navigates to a route
    App->>Router: Calls `navigate` method
    Router->>Provider: Uses `NextUIProvider` for rendering
    Provider-->>App: Provides UI context
    App-->>User: Displays the requested route

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.