Skip to content

docs(examples): fix Solid README dev commands#10430

Merged
TkDodo merged 1 commit intoTanStack:mainfrom
grzdev:docs-solid-readme-dev-commands
Apr 9, 2026
Merged

docs(examples): fix Solid README dev commands#10430
TkDodo merged 1 commit intoTanStack:mainfrom
grzdev:docs-solid-readme-dev-commands

Conversation

@grzdev
Copy link
Copy Markdown
Contributor

@grzdev grzdev commented Apr 8, 2026 •
edited by coderabbitai bot
Loading

🎯 Changes

Fixes Solid example README run commands so they match the actual scripts
defined in the example packages.

Several Solid example READMEs currently instruct contributors to run
npm run start, but the corresponding examples expose dev instead.
Following the README results in a missing-script error.

This change updates the affected READMEs to use the correct dev script
and aligns commands with the repo’s pnpm standard.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated setup and execution instructions across multiple Solid framework examples with current package manager and build commands.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 672353de-1d5a-4741-90af-1e799fac5a65

📥 Commits

Reviewing files that changed from the base of the PR and between ef62f7b and a6d8c4f.

📒 Files selected for processing (5)
  • examples/solid/basic-graphql-request/README.md
  • examples/solid/basic/README.md
  • examples/solid/default-query-function/README.md
  • examples/solid/offline/README.md
  • examples/solid/simple/README.md
📝 Walkthrough

Walkthrough

Updated package manager and run commands in multiple Solid example README files, replacing npm install and npm run start with pnpm install and pnpm dev respectively.

Changes

Cohort / File(s) Summary
Solid Examples Documentation
examples/solid/basic-graphql-request/README.md, examples/solid/basic/README.md, examples/solid/default-query-function/README.md, examples/solid/offline/README.md, examples/solid/simple/README.md		 Replaced npm package manager commands with pnpm equivalents in example run instructions: npm install → pnpm install and npm run start → pnpm dev.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hopping through examples with glee,
From npm to pnpm, so spree!
Five docs now gleam,
With scripts supreme,
Package commands now align with thee! 📦✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and specifically describes the main change: fixing Solid README dev commands to match actual scripts.
Description check ✅ Passed The description follows the template with all required sections filled out: Changes clearly explain the issue and fix, Checklist items are completed, and Release Impact correctly identifies this as docs-only.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@nx-cloud
Copy link
Copy Markdown

nx-cloud bot commented Apr 8, 2026 •
edited
Loading

View your CI Pipeline Execution ↗ for commit a6d8c4f

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 15s View ↗

☁️ Nx Cloud last updated this comment at 2026-04-08 21:58:39 UTC

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 8, 2026

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10430

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10430

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10430

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10430

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10430

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10430

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10430

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10430

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10430

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10430

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10430

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10430

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10430

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10430

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10430

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10430

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10430

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10430

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10430

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10430

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10430

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10430

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10430

commit: a6d8c4f

@TkDodo TkDodo merged commit c945694 into TanStack:main Apr 9, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@grzdev @TkDodo