Skip to content

docs(examples): fix Vue example README headings#10432

Merged
TkDodo merged 1 commit intoTanStack:mainfrom
grzdev:docs-vue-example-readme-headings
Apr 9, 2026
Merged

docs(examples): fix Vue example README headings#10432
TkDodo merged 1 commit intoTanStack:mainfrom
grzdev:docs-vue-example-readme-headings

Conversation

@grzdev
Copy link
Copy Markdown
Contributor

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

🎯 Changes

Fixes incorrect headings in two Vue example READMEs.

Both persister and simple were labeled as Basic example, which looks like
a copy-paste mistake and makes the examples harder to distinguish when browsing
the repo.

This change updates each README heading to match the example it documents.

✅ 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 Vue example README titles to accurately identify the Persister and Simple example types.

@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: fc77ef22-c3e2-4523-919e-bbffdbc86b2f

📥 Commits

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

📒 Files selected for processing (2)
  • examples/vue/persister/README.md
  • examples/vue/simple/README.md
📝 Walkthrough

Walkthrough

Two example README files received title updates to better reflect their respective example types: the persister example and simple example. No functional, configuration, or instructional content was modified.

Changes

Cohort / File(s) Summary
Documentation Updates
examples/vue/persister/README.md, examples/vue/simple/README.md		 Updated README titles from generic "Basic example" to descriptive titles ("Persister example" and "Simple example") to clarify example purposes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A hop, a skip, and titles bloom,
From "basic" vague to clarity's room,
Persister and Simple now shine so bright,
These examples guide with newfound light! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing Vue example README headings, which aligns with the actual modifications to the two example README files.
Description check ✅ Passed The description follows the template structure completely, includes clear explanation of the changes with context about the copy-paste error, and indicates this is a docs-only change with no release impact required.
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 e9c376a

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 22:11:59 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@10432

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: e9c376a

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