- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 1.3k
docs(solid-start): add framework flag to solid start cli commands #5707
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.
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
base: main
Are you sure you want to change the base?
Conversation
| WalkthroughUpdated TanStack Start CLI quick-start documentation for the Solid framework by adding the  Changes
 Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 
 Possibly related PRs
 Suggested labels
 Poem
 Pre-merge checks and finishing touches❌ Failed checks (1 warning)
 ✅ Passed checks (2 passed)
 ✨ 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  | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/start/framework/solid/quick-start.md (1)
10-12: Add language specification to fenced code blocks.Both command blocks are missing language specifications, which violates MD040. The rest of the file uses
bashfor code blocks (lines 24–61), so add the same here for consistency.Apply this diff to fix the code block formatting:
-\`\`\` +\`\`\`bash pnpm create @tanstack/start@latest --framework solid -\`\`\` +\`\`\` or -\`\`\` +\`\`\`bash npm create @tanstack/start@latest -- --framework solid -\`\`\` +\`\`\`Also applies to: 16-18
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
- docs/start/framework/solid/getting-started.md(1 hunks)
- docs/start/framework/solid/quick-start.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)
Files:
- docs/start/framework/solid/getting-started.md
- docs/start/framework/solid/quick-start.md
docs/{router,start}/**
📄 CodeRabbit inference engine (AGENTS.md)
Place router docs under docs/router/ and start framework docs under docs/start/
Files:
- docs/start/framework/solid/getting-started.md
- docs/start/framework/solid/quick-start.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: TanStack/router PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-23T17:36:12.598Z
Learning: Applies to docs/{router,start}/** : Place router docs under docs/router/ and start framework docs under docs/start/
🪛 markdownlint-cli2 (0.18.1)
docs/start/framework/solid/getting-started.md
10-10: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
docs/start/framework/solid/getting-started.md (1)
10-10: ✓ Command correctly updated with framework flag.The inline CLI command properly includes
--framework solidto pre-select the Solid framework during project initialization, aligning with the PR objectives.docs/start/framework/solid/quick-start.md (1)
11-11: ✓ CLI commands correctly include framework flag.The pnpm and npm commands properly use the
--framework solidflag. The npm syntax with--to pass arguments is correct.Also applies to: 17-17
Update solid docs to include the
--framework solidflag in thecreate @tanstack/startcommands.https://github.com/TanStack/create-tsrouter-app/blob/453a72f6c4b008f1cac3cf46b78e2f0b1a15ee8c/cli/ts-create-start/README.md?plain=1#L14
Summary by CodeRabbit
--framework solidflag for npm and pnpm, enabling direct framework pre-selection during project initialization without additional interactive prompts.