Skip to content

Conversation

@hynjnk
Copy link

@hynjnk hynjnk commented Oct 31, 2025

Update solid docs to include the --framework solid flag in the create @tanstack/start commands.
https://github.com/TanStack/create-tsrouter-app/blob/453a72f6c4b008f1cac3cf46b78e2f0b1a15ee8c/cli/ts-create-start/README.md?plain=1#L14

Summary by CodeRabbit

  • Documentation
    • Updated quick-start and getting-started guides for Solid framework projects.
    • CLI commands now include the --framework solid flag for npm and pnpm, enabling direct framework pre-selection during project initialization without additional interactive prompts.

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

coderabbitai bot commented Oct 31, 2025

Walkthrough

Updated TanStack Start CLI quick-start documentation for the Solid framework by adding the --framework solid flag to npm and pnpm create commands, enabling pre-selection of the Solid framework during project initialization.

Changes

Cohort / File(s) Change Summary
Solid Framework CLI Documentation
docs/start/framework/solid/getting-started.md, docs/start/framework/solid/quick-start.md
Added --framework solid flag to npm and pnpm create command examples to explicitly specify the Solid framework during project setup

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Simple, repetitive documentation updates with no logic changes
  • Consistent pattern applied across two related documentation files

Possibly related PRs

  • TanStack/router#5286: Updates TanStack Start CLI quick-start documentation for React framework with similar command-line flag modifications.

Suggested labels

documentation

Poem

🐰 A rabbit hops through Solid ground,
Framework flags now all around!
The CLI speaks with crystal tongue,
Pre-selecting Solid—tests all sung! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "docs(solid-start): add framework flag to solid start cli commands" directly and clearly describes the main change across both updated documentation files. The changes add the --framework solid flag to the TanStack Start CLI commands in the Solid framework getting-started and quick-start documentation, which precisely matches what the title communicates. The title is concise, specific, and avoids vague or generic language, making it clear to someone reviewing git history that this PR updates the Solid documentation with the framework flag.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 bash for 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

📥 Commits

Reviewing files that changed from the base of the PR and between 943d616 and 3fa2192.

📒 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 solid to 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 solid flag. The npm syntax with -- to pass arguments is correct.

Also applies to: 17-17

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