Skip to content

docs: add in llm support page - #5479

Merged
schiller-manuel merged 2 commits into
TanStack:mainfrom
LadyBluenotes:llm-rules
Oct 14, 2025
Merged

docs: add in llm support page#5479
schiller-manuel merged 2 commits into
TanStack:mainfrom
LadyBluenotes:llm-rules

Conversation

@LadyBluenotes

@LadyBluenotesLadyBluenotes commented Oct 14, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Added an “LLM Assistance Support” guide for TanStack Router (React), covering installation, usage with vibe-rules, supported editors, and Yarn Workspaces pnpm notes.
    • Added a Solid guide that aliases the React content for consistency.
    • Updated the docs navigation to include the new guide under Getting Started for both React and Solid.

@github-actionsgithub-actionsBot added the documentation Everything documentation related label Oct 14, 2025
@coderabbitai

coderabbitaiBot commented Oct 14, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Adds “LLM Assistance Support” documentation to the Router site: updates the docs navigation to include new entries under React and Solid, adds a React guide with installation/usage notes for vibe-rules and editor support, and adds a Solid page that aliases the React guide.

Changes

Cohort / File(s)Summary
Docs Navigation
docs/router/config.json
Adds “LLM Assistance Support” entries under the React and Solid sections of the Router docs navigation.
Framework Docs
docs/router/framework/react/llm-support.md, docs/router/framework/solid/llm-support.md
Adds a React LLM support guide (installation via pnpm, vibe-rules usage examples, supported editors, pnpm/Yarn workspace notes). Adds a Solid page that references/aliases the React guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

I hop through docs with ear held high,
New LLM paths beneath the sky.
React and Solid share the trail,
Vibe-rules notes in every detail.
Carrots guide the docs' bright art—
A rabbit’s cheer for every part. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe title clearly and concisely conveys the main change of adding an LLM support page to the documentation, follows conventional commit style, and avoids unnecessary detail or ambiguity.
Docstring Coverage✅ PassedNo functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud

nx-cloudBot commented Oct 14, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 966fa41

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded<1sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1sView ↗

☁️ Nx Cloud last updated this comment at 2025-10-14 17:49:05 UTC

@pkg-pr-new

pkg-pr-newBot commented Oct 14, 2025

Copy link
Copy Markdown
More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5479

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5479

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5479

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5479

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5479

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5479

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5479

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5479

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5479

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5479

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5479

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5479

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5479

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5479

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5479

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5479

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5479

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5479

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5479

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5479

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5479

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5479

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5479

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5479

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5479

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5479

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5479

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5479

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5479

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5479

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5479

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5479

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5479

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5479

commit: 966fa41

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84a4b24 and 0de82bb.

📒 Files selected for processing (3)
  • docs/router/config.json (2 hunks)
  • docs/router/framework/react/llm-support.md (1 hunks)
  • docs/router/framework/solid/llm-support.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/router/framework/react/llm-support.md
  • docs/router/framework/solid/llm-support.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/router/framework/react/llm-support.md
  • docs/router/config.json
  • docs/router/framework/solid/llm-support.md
🪛 LanguageTool
docs/router/framework/react/llm-support.md

[grammar] ~16-~16: There might be a mistake here.
Context: ...-rules ``` Once installed, you can run then run it in the editor of your choice. For ex...

(QB_NEW_EN)


[style] ~24-~24: Consider using a more concise synonym.
Context: ...upported Editors vibe-rules supports a variety of editors, including windsurf, `claude-...

(A_VARIETY_OF)

docs/router/framework/solid/llm-support.md

[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ref: docs/router/framework/react/llm-support.md ---

(QB_NEW_DE)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Preview

Comment threaddocs/router/framework/react/llm-support.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/router/framework/react/llm-support.md (1)

16-16: Trim redundant “then” for smoother flow.

Drop “then” so the sentence reads “Once installed, you can run it…”.

-Once installed, you can then run it in the editor of your choice.+Once installed, you can run it in the editor of your choice.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0de82bb and 966fa41.

📒 Files selected for processing (1)
  • docs/router/framework/react/llm-support.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/router/framework/react/llm-support.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/router/framework/react/llm-support.md
🪛 LanguageTool
docs/router/framework/react/llm-support.md

[style] ~24-~24: Consider using a more concise synonym.
Context: ...upported Editors vibe-rules supports a variety of editors, including windsurf, `claude-...

(A_VARIETY_OF)

@schiller-manuel
schiller-manuel merged commit 294b82a into TanStack:mainOct 14, 2025
6 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationEverything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@LadyBluenotes@schiller-manuel