Skip to content

docs: fix and Improve documentation#794

Open
afsuyadi wants to merge 5 commits intoTanStack:mainfrom
afsuyadi:improve_documentation
Open

docs: fix and Improve documentation#794
afsuyadi wants to merge 5 commits intoTanStack:mainfrom
afsuyadi:improve_documentation

Conversation

@afsuyadi
Copy link
Copy Markdown

@afsuyadi afsuyadi commented Mar 29, 2026

  1. Fix missing space
    before: between useQueryand imperative methods
    after: between useQuery and imperative methods`

  2. Fix subject-verb disagreement
    before: It's the people that makes this library great
    after: the people that make this library great

  3. Fix missing article
    before: No matter if you're core contributor
    after: No matter if you're a core contributor

  4. Fix a misplaced period creating a sentence fragment
    before: which increases perceived language service speed. significantly
    after: which increases perceived language service speed significantly.

  5. Fix 8 instances of lowercase after a period (lines 17, 27, 29, 35, 41, 57, 61, 67)
    Pattern: X isn't just Y. it's Z → X isn't just Y. It's Z

Examples:
Line 17: isn't just a buzzword. it's → buzzword. It's
Line 27: isn't just supported. it's encouraged → supported. It's
Line 67: build great tools. it's to build → tools. It's to build
(and 5 more identical pattern)

Summary by CodeRabbit

  • Documentation
    • Fixed grammar, whitespace, and punctuation across multiple blog articles for improved readability.
    • Standardized capitalization in blog post content for consistent formatting.

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 29, 2026

👷 Deploy request for tanstack pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 3a40a87

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 29, 2026

📝 Walkthrough

Walkthrough

Three blog post files receive minor textual corrections: whitespace normalization, grammar improvements for article usage, and punctuation adjustments. No functional code changes are present.

Changes

Cohort / File(s) Summary
Blog Documentation Text Corrections
src/blog/announcing-tanstack-query-v5.md, src/blog/tanstack-router-typescript-performance.md, src/blog/why-tanstack-start-and-router.md
Fixed whitespace around useQuery, added missing article "a" in "core contributor", corrected punctuation, and standardized capitalization of "It's" in sentence positions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through words so fine,
Fixing spaces, one by one in line,
Capitalizing letters that were low,
Grammar blooms—the prose will glow! 🐇✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: fix and Improve documentation' is partially related to the changeset. It mentions 'fix' which aligns with the PR's actual purpose of fixing grammar, spacing, and capitalization errors, but 'Improve documentation' is vague and overstates the scope—the changes are editorial corrections rather than substantive improvements. Consider a more specific title like 'docs: fix grammar, spacing, and capitalization errors' to better reflect the actual scope of editorial corrections being made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.

@afsuyadi afsuyadi changed the title Improve documentation docs: fix and Improve documentation Mar 29, 2026
Copy link
Copy Markdown

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/blog/announcing-tanstack-query-v5.md`:
- Line 63: Replace the ungrammatical sentence "What's left for us to say thanks
to everyone who made this release possible." with a corrected phrasing such as
"What’s left for us is to say thanks to everyone who made this release
possible." (or "All that’s left is to say thanks to everyone who made this
release possible.") in the markdown content so the first sentence on that
paragraph is grammatically correct.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a72a9925-49f2-4188-a5b3-1fc50265fcdd

📥 Commits

Reviewing files that changed from the base of the PR and between db44d55 and 3a40a87.

📒 Files selected for processing (3)
  • src/blog/announcing-tanstack-query-v5.md
  • src/blog/tanstack-router-typescript-performance.md
  • src/blog/why-tanstack-start-and-router.md

## THANK YOU

We hope you're going to enjoy using v5 as much as we've enjoyed building it. What's left for us to say thanks to everyone who made this release possible. No matter if you're core contributor, implemented an issue from the roadmap, if you've fixed a typo in the docs or gave feedback on the alpha releases: Every contribution matters! It's the people that makes this library great, and we're blessed to have such an amazing community. ❤️
We hope you're going to enjoy using v5 as much as we've enjoyed building it. What's left for us to say thanks to everyone who made this release possible. No matter if you're a core contributor, implemented an issue from the roadmap, if you've fixed a typo in the docs or gave feedback on the alpha releases: Every contribution matters! It's the people that make this library great, and we're blessed to have such an amazing community. ❤️
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Line 63 still has a grammar glitch in the first sentence.

“What's left for us to say thanks…” is ungrammatical. Consider: “What’s left for us is to say thanks…” (or “All that’s left is to say thanks…”).

🧰 Tools
🪛 LanguageTool

[style] ~63-~63: Try using a synonym here to strengthen your writing.
Context: ..., if you've fixed a typo in the docs or gave feedback on the alpha releases: Every c...

(GIVE_PROVIDE)


[style] ~63-~63: Consider using “who” when you are referring to people instead of objects.
Context: ...y contribution matters! It's the people that make this library great, and we're bles...

(THAT_WHO)


[style] ~63-~63: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...y great, and we're blessed to have such an amazing community. ❤️

(AWESOME)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/blog/announcing-tanstack-query-v5.md` at line 63, Replace the
ungrammatical sentence "What's left for us to say thanks to everyone who made
this release possible." with a corrected phrasing such as "What’s left for us is
to say thanks to everyone who made this release possible." (or "All that’s left
is to say thanks to everyone who made this release possible.") in the markdown
content so the first sentence on that paragraph is grammatically correct.

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.

1 participant