Skip to content

Conversation

@nexckycort
Copy link

@nexckycort nexckycort commented Jan 15, 2026

Summary by CodeRabbit

Documentation

  • Corrected the TanStack Start CLI command example in the Solid framework Getting Started documentation. The command syntax has been updated to ensure users have the accurate installation instructions for creating new projects with the Solid framework, following current best practices.

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

@github-actions github-actions bot added the documentation Everything documentation related label Jan 15, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 15, 2026

📝 Walkthrough

Walkthrough

A CLI command syntax in the Solid framework Getting Started documentation is updated from npm create @tanstack/start@latest -- --framework solid to npm create @tanstack/start@latest --framework solid, removing an extra -- separator.

Changes

Cohort / File(s) Summary
Documentation Update
docs/start/framework/solid/getting-started.md
Updated TanStack Start CLI invocation syntax: removed extra -- separator in npm create command for Solid framework

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • TanStack/router#5286: Updates CLI command syntax in React framework Getting Started documentation with similar command-line option changes
  • TanStack/router#5707: Directly modifies the same Solid framework documentation line regarding the npm create @tanstack/start@latest command invocation

Suggested labels

documentation

Suggested reviewers

  • birkskyum

Poem

🐰 A tiny tweak in docs so fine,
One dash removed, the syntax shines,
npm create now flows with grace,
Solid ground, a better place! ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the specific change: fixing a CLI command syntax issue in the Solid Start getting started documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.



📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86605e3 and fb00d20.

📒 Files selected for processing (1)
  • docs/start/framework/solid/getting-started.md
🧰 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/solid/getting-started.md
🔇 Additional comments (1)
docs/start/framework/solid/getting-started.md (1)

10-10: Add the project name argument to the CLI command.

The command is missing the required my-app argument. According to the official TanStack Start documentation, the correct syntax is:

npm create `@tanstack/start`@latest my-app --framework solid

Users need to replace my-app with their desired project name. The removal of -- is correct; however, omitting the project name argument will cause the command to fail.

⛔ Skipped due to learnings
Learnt from: nlynzaad
Repo: TanStack/router PR: 6215
File: e2e/react-start/custom-basepath/package.json:13-17
Timestamp: 2025-12-25T13:04:55.492Z
Learning: In the TanStack Router repository, e2e test scripts are specifically designed to run in CI (which uses a Unix environment), so Unix-specific commands (like `rm -rf`, `&` for backgrounding, and direct environment variable assignments without `cross-env`) are acceptable in e2e test npm scripts.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


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.

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

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant