Skip to content

Conversation

@LadyBluenotes
Copy link
Contributor

@LadyBluenotes LadyBluenotes commented Sep 16, 2025

  • Updated README to be similar to other TanStack libraries
  • Included sponsors
  • Included ecosystem links

Summary by CodeRabbit

  • Documentation
    • Refreshed README hero with a centered local image and simplified title.
    • Streamlined badges (downloads, stars, bundle size, semantic-release); added Best of JS, Twitter follow, and sponsor callout.
    • Condensed overview with adapter note and core capabilities.
    • Modernized Get Involved/Partners with updated logos and copy.
    • Curated ecosystem links with a TanStack.com prompt.
    • Removed legacy, verbose sections for clearer, leaner content.
    • No API changes.

@coderabbitai
Copy link

coderabbitai bot commented Sep 16, 2025

Walkthrough

README.md was overhauled: header image changed to a centered local asset, badges reorganized and updated, sections simplified and refocused on ecosystem links, outdated/legacy sections removed, partner/sponsor areas refreshed, notes on adapter names added, and layout streamlined while preserving essential links (e.g., docs).

Changes

Cohort / File(s) Summary of Changes
README overhaul
README.md
Replaced remote header image with centered local media; removed old title; restructured hero with new badges (npm, stars, size, semantic-release), sponsor prompt; updated social badges (Best of JS, Twitter); added adapter note and concise capabilities list; simplified sponsors/partners; condensed ecosystem links; removed legacy sections; retained docs link; added closing TanStack.com prompt.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I thump my paws on README ground,
New badges bloom, old sections slimmed down.
With stars and downloads shining bright,
Sponsors hop into the light.
A leaner path, swift to roam—
Follow the links, then bound back home. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Update README" is concise and directly describes the primary change in this PR (substantial README modifications including badges, sponsor links, and ecosystem edits), so it is related to the changeset and signals a documentation-focused update; although somewhat generic, it still conveys the main intent to reviewers.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

@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 (7)
README.md (7)

11-13: Fix GitHub stars badge repo slug.

The badge points to tanstack/react-table; this repo is TanStack/table. Update the badge source to avoid stale stats.

-  <img alt="github stars" src="https://img.shields.io/github/stars/tanstack/react-table.svg?style=social&label=Star" />
+  <img alt="github stars" src="https://img.shields.io/github/stars/TanStack/table.svg?style=social&label=Star" />

52-52: Fix heading level to satisfy MD001.

Jumping from H1 to H3 violates markdownlint MD001; use H2.

-### <a href="https://tanstack.com/table">Read the Docs →</a>
+## <a href="https://tanstack.com/table">Read the Docs →</a>

47-51: Broaden framework bindings claim (adapters exist for more than React/Vue/Solid).

This line under-represents supported adapters (Angular, Lit, Qwik, Svelte, etc.). Either generalize or list them.

-- Framework‑agnostic core with bindings for React, Vue & Solid
+- Framework‑agnostic core with adapters for React, Vue, Solid, Svelte, Angular, Qwik, and Lit

If you prefer brevity:

-- Framework‑agnostic core with bindings for React, Vue & Solid
+- Framework‑agnostic core with adapters for all major frameworks

67-70: Replace invalid HTML attributes with inline styles.

padding isn’t a valid attribute on <img> or <td>. Use style.

-<img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" padding="20px" alt="Code Rabbit"/>
+<img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" style="padding: 20px" alt="Code Rabbit"/>

-<td padding="20">
+<td style="padding: 20px">

20-23: Make the semantic‑release badge link meaningful.

href="#badge" is a dead anchor. Link to semantic‑release.

-<a href="#badge">
+<a href="https://github.com/semantic-release/semantic-release">
   <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
 </a>

106-106: Correct TanStack Start URL.

Link currently points to the Router repo.

-<a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+<a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> – Full‑stack SSR & streaming

8-10: Remove escaped target="\_parent" (not needed; may be sanitized).

GitHub often strips target; the escaped value is non‑standard. Safer to omit.

-<a href="https://npmjs.com/package/@tanstack/react-table" target="\_parent">
+<a href="https://npmjs.com/package/@tanstack/react-table">
 ...
-<a href="https://github.com/tanstack/table" target="\_parent">
+<a href="https://github.com/tanstack/table">

Also applies to: 11-13

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c62cf2 and 6bd1769.

⛔ Files ignored due to path filters (2)
  • media/header_table.png is excluded by !**/*.png
  • media/partner_logo.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

52-52: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🔇 Additional comments (1)
README.md (1)

1-3: Assets present — no action required

Both ./media/header_table.png and ./media/partner_logo.svg are present in the PR (verified).

@KevinVandy KevinVandy merged commit bf0783c into TanStack:main Sep 17, 2025
1 check passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 17, 2025
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