Skip to content

docs: add commands each example #6004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
enBonnet wants to merge 15 commits into
base: main
Choose a base branch
from
Open

docs: add commands each example #6004

enBonnet wants to merge 15 commits into from
+196 −0

Conversation

@enBonnet
Copy link
Contributor

@enBonnet enBonnet commented Dec 1, 2025 •
edited by coderabbitai bot
Loading

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:

Screenshot 2025-12-01 105024
Screenshot 2025-12-01 105045

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.

@github-actions github-actions bot added the documentation Everything documentation related label Dec 1, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 1, 2025 •
edited
Loading

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
Copy link

nx-cloud bot commented Dec 3, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 4ecee20

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

☁️ Nx Cloud last updated this comment at 2025-12-06 15:16:09 UTC

autofix-ci bot and others added 13 commits December 3, 2025 05:25
@autofix-ci
ci: apply automated fixes
54079ef
@hakanshehu @nlynzaad @enBonnet
fix(router-core): correctly resolve custom params from declarative ma…
f113f0f 
…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 <[email protected]>
@tannerlinsley @enBonnet
release: v1.139.13
0781bdf
@Sheraff @enBonnet
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
@tannerlinsley @enBonnet
release: v1.139.14
b563248
@lachlancollins @enBonnet
docs: correct local relative links (TanStack#6027)
bec0bb2 
* docs: correct local relative links

* Missing fixes

* Fix lockfile
@vemoo @enBonnet
fix(router-devtools): move vite to devDependencies (TanStack#6026)
e818386
@Yavnik @enBonnet
docs: remove gitignore suggestion for generated route tree file (TanS…
071602d 
…tack#6025)

docs: remove gitignore suggestion for generated routing files in start docs
@tannerlinsley @enBonnet
release: v1.139.15
09c827b
@enBonnet @SeanCassiere
docs(examples): standardize the READMEs for the React examples (TanSt…
bfb7b6c 
…ack#6014)

Co-authored-by: Sean Cassiere <[email protected]>
@morinokami @enBonnet
docs(start): update the "reading-writing-file" tutorial (TanStack#6031)
bf8be9f
@Armanio @enBonnet
chore(router-core): remove extra JSDoc comments for `defaultParseSear…
a2f25d3 
…ch` (TanStack#6020)
@lachlancollins @enBonnet
ci: prepare for trusted publishing (TanStack#6032)
77e4d5d
@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 6, 2025

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/zod-adapter

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

commit: 4ecee20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Everything documentation related package: arktype-adapter package: react-router package: react-router-devtools package: react-router-ssr-query package: react-start package: react-start-client package: react-start-server package: router-cli package: router-core package: router-devtools package: router-devtools-core package: router-generator package: router-plugin package: router-ssr-query-core package: router-vite-plugin package: solid-router package: solid-router-devtools package: solid-router-ssr-query package: solid-start package: solid-start-client package: solid-start-server package: start-client-core package: start-plugin-core package: start-server-core package: start-static-server-functions package: start-storage-context package: valibot-adapter package: zod-adapter

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@enBonnet @hakanshehu @tannerlinsley @Sheraff @lachlancollins @vemoo @Yavnik @morinokami @Armanio