From 0de82bbd711ab6c8a113a56e72cbf04b5564274f Mon Sep 17 00:00:00 2001 From: LadyBluenotes Date: Tue, 14 Oct 2025 10:38:26 -0700 Subject: [PATCH 1/2] llm-rules page --- docs/router/config.json | 8 ++++++ docs/router/framework/react/llm-support.md | 31 ++++++++++++++++++++++ docs/router/framework/solid/llm-support.md | 3 +++ 3 files changed, 42 insertions(+) create mode 100644 docs/router/framework/react/llm-support.md create mode 100644 docs/router/framework/solid/llm-support.md diff --git a/docs/router/config.json b/docs/router/config.json index 6eef4eb340b..48eac3cd055 100644 --- a/docs/router/config.json +++ b/docs/router/config.json @@ -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" @@ -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" diff --git a/docs/router/framework/react/llm-support.md b/docs/router/framework/react/llm-support.md new file mode 100644 index 00000000000..18e1a76e09f --- /dev/null +++ b/docs/router/framework/react/llm-support.md @@ -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 run 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 +> ``` diff --git a/docs/router/framework/solid/llm-support.md b/docs/router/framework/solid/llm-support.md new file mode 100644 index 00000000000..7e92494073e --- /dev/null +++ b/docs/router/framework/solid/llm-support.md @@ -0,0 +1,3 @@ +--- +ref: docs/router/framework/react/llm-support.md +--- From 966fa419a6b9c71244411d1747f8d22a779ba6be Mon Sep 17 00:00:00 2001 From: LadyBluenotes Date: Tue, 14 Oct 2025 10:47:44 -0700 Subject: [PATCH 2/2] remove duplicated word --- docs/router/framework/react/llm-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/router/framework/react/llm-support.md b/docs/router/framework/react/llm-support.md index 18e1a76e09f..2a3757bba29 100644 --- a/docs/router/framework/react/llm-support.md +++ b/docs/router/framework/react/llm-support.md @@ -13,7 +13,7 @@ To use `vibe-rules`, install it globally using your package manager of choice. F pnpm add -g vibe-rules ``` -Once installed, you can run then run it in the editor of your choice. For example, to integrate with Cursor: +Once installed, you can then run it in the editor of your choice. For example, to integrate with Cursor: ```bash vibe-rules install cursor