Skip to content

Commit 294b82a

Browse files
docs: add in llm support page (#5479)
* llm-rules page * remove duplicated word
1 parent 84a4b24 commit 294b82a

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

docs/router/config.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@
2929
"label": "Decisions on DX",
3030
"to": "framework/react/decisions-on-dx"
3131
},
32+
{
33+
"label": "LLM Assistance Support",
34+
"to": "framework/react/llm-support"
35+
},
3236
{
3337
"label": "Frequently Asked Questions",
3438
"to": "framework/react/faq"
@@ -54,6 +58,10 @@
5458
"label": "Decisions on DX",
5559
"to": "framework/solid/decisions-on-dx"
5660
},
61+
{
62+
"label": "LLM Assistance Support",
63+
"to": "framework/solid/llm-support"
64+
},
5765
{
5866
"label": "Frequently Asked Questions",
5967
"to": "framework/solid/faq"
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
id: llm-assistance
3+
title: LLM Assistance Support
4+
---
5+
6+
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).
7+
8+
## Installation
9+
10+
To use `vibe-rules`, install it globally using your package manager of choice. For example, with `pnpm`:
11+
12+
```bash
13+
pnpm add -g vibe-rules
14+
```
15+
16+
Once installed, you can then run it in the editor of your choice. For example, to integrate with Cursor:
17+
18+
```bash
19+
vibe-rules install cursor
20+
```
21+
22+
## Supported Editors
23+
24+
`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).
25+
26+
> [!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:
27+
>
28+
> ```yaml
29+
> pnpFallbackMode: all
30+
> pnpMode: loose
31+
> ```
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
ref: docs/router/framework/react/llm-support.md
3+
---

0 commit comments

Comments
 (0)