-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Update README #6096
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README #6096
Conversation
WalkthroughREADME.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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
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.
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. Comment |
There was a problem hiding this 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 LitIf 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.
paddingisn’t a valid attribute on<img>or<td>. Usestyle.-<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 escapedtarget="\_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
⛔ Files ignored due to path filters (2)
media/header_table.pngis excluded by!**/*.pngmedia/partner_logo.svgis 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 requiredBoth ./media/header_table.png and ./media/partner_logo.svg are present in the PR (verified).
Summary by CodeRabbit