docs: add commands each example by enBonnet · Pull Request #6004 · TanStack/router

enBonnet · 2025-12-01T13:53:29Z

I was trying to use a starter but it took me some tries to copy the proper URL and get the command to use it, so I came back to add the link for each example, it could make it easy for other.

I'll look like this after changes:

Summary by CodeRabbit

Documentation
- React quick-start guide: added collapsible "Show command" sections that pair each example with a corresponding GitPick shell command for quick reference.
- Content-only update — no changes to navigation, behavior, or public APIs were made.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-01T13:53:43Z

Walkthrough

Added multiple collapsible <details> blocks to the React quick-start guide, each containing a "Show command" summary and a GitPick CLI code snippet. Changes are documentation-only and replicate adjacent command examples across several list items in the guide.

Changes

Cohort / File(s)	Summary
Documentation expansion `docs/start/framework/react/quick-start.md`	Inserted several `<details>` sections with `<summary>` and fenced code blocks showing shell commands and corresponding GitPick CLI usage; pattern mirrors existing "Show command" examples throughout the document.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Repetitive, homogeneous Markdown/HTML additions.
Verify Markdown/HTML validity and consistent formatting of code fences.

Possibly related PRs

docs: quickstart #5286 — Modifies the same docs/start/framework/react/quick-start.md file and related CLI/command examples.

Poem

🐰
Hop, I nibble at the guide tonight,
Folding details neat and tight,
Commands tucked in cozy lairs,
GitPick whispers in the hairs,
Quick-start hops into the light.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add commands each example' is directly related to the main change - adding command blocks/links to examples in the documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e6e1121 and 4ecee20.

📒 Files selected for processing (1)

docs/start/framework/react/quick-start.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use relative links to docs/ folder format (e.g., ./guide/data-loading) for internal documentation references

Files:

docs/start/framework/react/quick-start.md

🔇 Additional comments (1)

docs/start/framework/react/quick-start.md (1)

40-282: Excellent documentation enhancement with consistent formatting and accurate commands.

All 22 collapsible command blocks are properly structured, accurately match their corresponding example slugs, and follow consistent formatting conventions. The gitpick commands are correctly formatted and will help users easily copy the exact command needed for each example.

The existing relative links to internal documentation (lines 33 and 158) already follow the required format (./guide/routing) per coding guidelines.

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 · 2025-12-03T05:24:31Z

View your CI Pipeline Execution ↗ for commit 79323be

Command	Status	Duration	Result
`nx affected --targets=test:eslint,test:unit,tes...`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	2s	View ↗

☁️ Nx Cloud last updated this comment at 2025-12-07 15:04:43 UTC

…sks when building the masked url (TanStack#5756) * Use params from declarative masks * Add tests for masks * Include the necessary changes * Update mask tests * Add e2e tests * minor nitpicks --------- Co-authored-by: Nico Lynzaad <nlynzaad@zylangroup.com>

…Path for params extraction (TanStack#6015) * fix(router-core): matching competing optional routes uses proper fullPath for params extraction * remove debug console.log

* docs: correct local relative links * Missing fixes * Fix lockfile

…tack#6025) docs: remove gitignore suggestion for generated routing files in start docs

…ack#6014) Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

…ch` (TanStack#6020)

pkg-pr-new · 2025-12-06T15:17:09Z

More templates

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

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

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-router-ssr-query

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/vue-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router@6004

@tanstack/vue-router-devtools

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

@tanstack/vue-router-ssr-query

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

@tanstack/zod-adapter

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

commit: 79323be

LadyBluenotes · 2026-07-17T04:32:10Z

Sorry this sat. I’m going to close it because quick-start.md has since been merged into the Getting Started guide, which includes the GitPick command pattern, and each example README now has its exact clone command. This covers the original usability issue without repeating a command block for every example.

docs: add commands each example

e6e1121

github-actions Bot added the documentation Everything documentation related label Dec 1, 2025

autofix-ci Bot and others added 13 commits December 3, 2025 05:25

ci: apply automated fixes

54079ef

release: v1.139.13

0781bdf

fix(router-core): matching competing optional routes uses proper full…

0a1da4a

…Path for params extraction (TanStack#6015) * fix(router-core): matching competing optional routes uses proper fullPath for params extraction * remove debug console.log

release: v1.139.14

b563248

docs: correct local relative links (TanStack#6027)

bec0bb2

* docs: correct local relative links * Missing fixes * Fix lockfile

fix(router-devtools): move vite to devDependencies (TanStack#6026)

e818386

docs: remove gitignore suggestion for generated route tree file (TanS…

071602d

…tack#6025) docs: remove gitignore suggestion for generated routing files in start docs

release: v1.139.15

09c827b

docs(examples): standardize the READMEs for the React examples (TanSt…

bfb7b6c

…ack#6014) Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

docs(start): update the "reading-writing-file" tutorial (TanStack#6031)

bf8be9f

chore(router-core): remove extra JSDoc comments for `defaultParseSear…

a2f25d3

…ch` (TanStack#6020)

ci: prepare for trusted publishing (TanStack#6032)

77e4d5d

Merge branch 'main' into docs/add-command-to-react-examples

4ecee20

Merge branch 'main' into docs/add-command-to-react-examples

79323be

LadyBluenotes closed this Jul 17, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: add commands each example - #6004

docs: add commands each example#6004
enBonnet wants to merge 16 commits into
TanStack:mainfrom
enBonnet:docs/add-command-to-react-examples

enBonnet commented Dec 1, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

nx-cloud Bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Dec 6, 2025 •

edited

Loading

Uh oh!

LadyBluenotes commented Jul 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Uh oh!

Uh oh!

Conversation

enBonnet commented Dec 1, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

nx-cloud Bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LadyBluenotes commented Jul 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

enBonnet commented Dec 1, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Dec 1, 2025 •

edited

Loading

nx-cloud Bot commented Dec 3, 2025 •

edited

Loading

pkg-pr-new Bot commented Dec 6, 2025 •

edited

Loading