docs: use @tanstack/cli to create tanstack/router app#7008
docs: use @tanstack/cli to create tanstack/router app#7008birkskyum merged 4 commits intoTanStack:mainfrom
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughUpdated quick-start scaffold commands to use Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/router/quick-start.md (1)
32-47:⚠️ Potential issue | 🟡 MinorSection promises direct commands but none are shown.
Line 32 says users can run commands directly, but this section no longer includes those examples, and the remaining tab end-markers suggest an incomplete edit. Please either restore direct command examples or reword the intro text to avoid a dead-end.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/router/quick-start.md` around lines 32 - 47, The intro claims users can "use these commands directly" but no commands are present and leftover tab markers imply an incomplete edit; either restore example commands (e.g., one-liners for generating file-based routes and for scaffolding code-based routes) under the "File-Based Route Generation" and "Code-Based Route Configuration" headings, or change the opening sentence to something accurate (e.g., "You can choose file-based or code-based route configurations during CLI setup" or "Use the CLI to scaffold routes; examples below show approaches") and remove the stray tab markers, updating the content around the "File-Based Route Generation" and "Code-Based Route Configuration" headings accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/router/quick-start.md`:
- Around line 32-47: The intro claims users can "use these commands directly"
but no commands are present and leftover tab markers imply an incomplete edit;
either restore example commands (e.g., one-liners for generating file-based
routes and for scaffolding code-based routes) under the "File-Based Route
Generation" and "Code-Based Route Configuration" headings, or change the opening
sentence to something accurate (e.g., "You can choose file-based or code-based
route configurations during CLI setup" or "Use the CLI to scaffold routes;
examples below show approaches") and remove the stray tab markers, updating the
content around the "File-Based Route Generation" and "Code-Based Route
Configuration" headings accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c0eec97b-d16f-48a0-a056-fed322c4aa47
📒 Files selected for processing (1)
docs/router/quick-start.md
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/router/quick-start.md (1)
28-28: Update link to official documentation for better user experience.Replace the GitHub repository link with the official
@tanstack/clidocumentation at https://tanstack.com/cli/latest/docs/overview or https://tanstack.com/cli/latest/docs, which provides dedicated documentation for CLI usage and options.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/router/quick-start.md` at line 28, Update the link target for the referenced "@tanstack/cli documentation" in the sentence containing "`@tanstack/cli` documentation" so it points to the official docs (use https://tanstack.com/cli/latest/docs/overview or https://tanstack.com/cli/latest/docs) instead of the GitHub repo; keep the visible text unchanged but replace the URL in the existing markdown link to the tanstack.com CLI docs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/router/quick-start.md`:
- Line 28: Update the link target for the referenced "@tanstack/cli
documentation" in the sentence containing "`@tanstack/cli` documentation" so it
points to the official docs (use https://tanstack.com/cli/latest/docs/overview
or https://tanstack.com/cli/latest/docs) instead of the GitHub repo; keep the
visible text unchanged but replace the URL in the existing markdown link to the
tanstack.com CLI docs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: eda8b42d-3f44-4747-a447-12c6f24cf7d1
📒 Files selected for processing (1)
docs/router/quick-start.md
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/router/quick-start.md`:
- Line 56: Replace the absolute URL in the markdown link labeled "code-based
routing documentation" with a relative repository link to the local doc (use
"routing/code-based-routing.md") so the link points to the internal file; update
the link target in the line containing "For more details, see the [code-based
routing
documentation](https://tanstack.com/router/latest/docs/routing/code-based-routing)
or" to use "[code-based routing documentation](routing/code-based-routing.md)".
- Line 38: In docs/router/quick-start.md replace the absolute URL to TanStack
Router's file-based routing with a repository-relative link pointing to
routing/file-based-routing.md (i.e., use the file-relative path instead of
https://tanstack.com/...), and also update the similar absolute link at the
later reference (line noted in the review) to routing/code-based-routing.md so
both internal docs use relative links.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: aa8e02f6-7963-47c5-a131-d421b0f92d3a
📒 Files selected for processing (1)
docs/router/quick-start.md
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/router/quick-start.md (1)
38-38:⚠️ Potential issue | 🟡 MinorInconsistent file extension in relative links.
Line 38 uses
./routing/file-based-routingwithout the.mdextension, while line 56 uses./routing/code-based-routing.mdwith the extension. For consistency, both should use the same format.📝 Proposed fix for consistency
Option 1: Remove
.mdfrom line 56 to match line 38:-For more details, see the [code-based routing documentation](./routing/code-based-routing.md) or +For more details, see the [code-based routing documentation](./routing/code-based-routing) orOption 2: Add
.mdto line 38 to match line 56:-For more details, see the [file-based routing documentation](./routing/file-based-routing) or +For more details, see the [file-based routing documentation](./routing/file-based-routing.md) orEither approach works; choose whichever convention is preferred for the project.
Also applies to: 56-56
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/router/quick-start.md` at line 38, Update the inconsistent relative link extensions in the quick-start content: choose one convention and make both links match — either change './routing/file-based-routing' to './routing/file-based-routing.md' or change './routing/code-based-routing.md' to './routing/code-based-routing' so the two links use the same format; adjust the string that appears in the text for consistency wherever referenced.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/router/quick-start.md`:
- Line 38: Update the inconsistent relative link extensions in the quick-start
content: choose one convention and make both links match — either change
'./routing/file-based-routing' to './routing/file-based-routing.md' or change
'./routing/code-based-routing.md' to './routing/code-based-routing' so the two
links use the same format; adjust the string that appears in the text for
consistency wherever referenced.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 3f2c42bd-c27d-4f6e-a6b3-f1bf98d442a1
📒 Files selected for processing (1)
docs/router/quick-start.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/router/quick-start.md`:
- Around line 40-50: The duplicated top-level headings "# React" and "# Solid"
in quick-start.md cause markdownlint MD001/MD024 warnings; change these repeated
headings to non-heading labels (e.g., replace "# React" and "# Solid" with
"**React**" and "**Solid**") or use uniquely scoped lower-level headings (e.g.,
"## React — Framework" / "## Solid — Framework") to preserve heading hierarchy,
and make the same adjustment for the other occurrences around lines 58-68 so
headings are unique and the document's heading progression remains valid.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e01d33d5-42e0-4fb9-9734-d027c879bfbe
📒 Files selected for processing (1)
docs/router/quick-start.md
|
View your CI Pipeline Execution ↗ for commit 9668511
☁️ Nx Cloud last updated this comment at |
2 participants
upadted quickstart docs to reduce friction, since
create-tsrouter-appis now marked as deprecated, and usage of@tanstack/cliis recommended now, as per warning given on project scaffoldthere are still two places where create-ts-router is referenced, but they are using custom templates -
shadcnandstartwhich is not supported with new commandbunx @tanstack/cli create --router-only my-app --template code-route │ ▲ The --router-only flag enables router-only compatibility mode. Start-dependent add-ons, deployment adapters, and templates are disabled; only the base template and optional toolchain are supported.Summary by CodeRabbit