Skip to content

docs(examples): add install step to preact simple README#10433

Merged
TkDodo merged 1 commit intoTanStack:mainfrom
grzdev:docs-preact-readme-install-step
Apr 9, 2026
Merged

docs(examples): add install step to preact simple README#10433
TkDodo merged 1 commit intoTanStack:mainfrom
grzdev:docs-preact-readme-install-step

Conversation

@grzdev
Copy link
Copy Markdown
Contributor

@grzdev grzdev commented Apr 8, 2026

🎯 Changes

Adds a missing install step to the preact simple example README.

The README previously jumped straight to pnpm dev, which can fail on a fresh
checkout if dependencies are not installed.

This change adds a minimal pnpm install step to make the setup flow complete.

✅ 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
    • Enhanced getting started guide with dependency installation instructions.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 239135ee-7771-49f7-a97a-8ccb9e7f31bc

📥 Commits

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

📒 Files selected for processing (1)
  • examples/preact/simple/README.md

📝 Walkthrough

Walkthrough

A "Getting Started" section was added to the Preact simple example README, documenting the pnpm install command for installing project dependencies. The change consists of two new lines with no modifications to existing content.

Changes

Cohort / File(s) Summary
Documentation
examples/preact/simple/README.md
Added Getting Started bullet point documenting the pnpm install dependency installation command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A hop and a bound through the docs so fine,
Installing deps with a line, so divine!
pnpm install, the path is clear,
Getting started brings developers cheer! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding an install step documentation to the preact simple example README.
Description check ✅ Passed The description follows the required template with all sections completed, including clear explanation of changes, checked checklist items, and release impact classification.
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

View your CI Pipeline Execution ↗ for commit e37d991

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

☁️ Nx Cloud last updated this comment at 2026-04-08 22:21:23 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@10433

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: e37d991

@TkDodo TkDodo merged commit 57a61d1 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants