router icon indicating copy to clipboard operation
router copied to clipboard

docs: add commands each example

Open enBonnet opened this issue 3 weeks ago β€’ 3 comments

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.

enBonnet avatar Dec 01 '25 13:12 enBonnet

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

  • TanStack/router#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 e6e11219c211c24deb2fd844748d804251adc379 and 4ecee2086be6bcbefae51992982d9a2064df2987.

πŸ“’ 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.

coderabbitai[bot] avatar Dec 01 '25 13:12 coderabbitai[bot]

View your CI Pipeline Execution β†— for commit 79323be59a72d4d68d6782c6fef830bf8045527a

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

nx-cloud[bot] avatar Dec 03 '25 05:12 nx-cloud[bot]

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

pkg-pr-new[bot] avatar Dec 06 '25 15:12 pkg-pr-new[bot]