Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/router/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
"label": "Decisions on DX",
"to": "framework/react/decisions-on-dx"
},
{
"label": "LLM Assistance Support",
"to": "framework/react/llm-support"
},
{
"label": "Frequently Asked Questions",
"to": "framework/react/faq"
Expand All @@ -54,6 +58,10 @@
"label": "Decisions on DX",
"to": "framework/solid/decisions-on-dx"
},
{
"label": "LLM Assistance Support",
"to": "framework/solid/llm-support"
},
{
"label": "Frequently Asked Questions",
"to": "framework/solid/faq"
Expand Down
31 changes: 31 additions & 0 deletions docs/router/framework/react/llm-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: llm-assistance
title: LLM Assistance Support
---

TanStack Router's documentation is integrated into its NPM module, making it available to install as LLM assistance rules. These rules can be integrated into various editors to provide context-aware help using [`vibe-rules`](https://www.npmjs.com/package/vibe-rules).

## Installation

To use `vibe-rules`, install it globally using your package manager of choice. For example, with `pnpm`:

```bash
pnpm add -g vibe-rules
```

Once installed, you can then run it in the editor of your choice. For example, to integrate with Cursor:

```bash
vibe-rules install cursor
```

## Supported Editors

`vibe-rules` supports a variety of editors, including `windsurf`, `claude-code`, and more. For more information on supported editors and how to set them up, refer to the [`vibe-rules` documentation](https://github.com/FutureExcited/vibe-rules).

> [!IMPORTANT] If you're using [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you will need to add the following configuration to your `.yarnrc.yaml` file of your application that uses TanStack Router:
>
> ```yaml
> pnpFallbackMode: all
> pnpMode: loose
> ```
3 changes: 3 additions & 0 deletions docs/router/framework/solid/llm-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
ref: docs/router/framework/react/llm-support.md
---
Loading