docs: Fix callout formatting - #6549
Merged
Merged
Conversation
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (146)
📝 WalkthroughWalkthroughThe pull request standardizes documentation callouts across framework guides and core guides. It converts legacy note, tip, warning, and important text to Markdown admonition syntax without changing the documented guidance. ChangesDocumentation admonition standardization
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Contributor
Author
|
I spotted another instance on https://tanstack.com/table/latest/docs/guide/data, and there are likely several more. Moving to draft until I get the chance to include all of them. |
mootari
marked this pull request as draft
August 13, 2026 10:10
Contributor
Author
|
I see 251 instances across 125 files where callouts use the wrong formatting (matched with @KevinVandy That's going to be a rather large PR. Should I include those fixes anyway or would you prefer to make the changes yourself? Or would you like to see a solution that coerces the blocks into the expected format during build, without changing the actual files? Edit: Here's a code search link. |
Converts all 341 remaining old-style callouts (> **Note:**, > NOTE:, > **NOTE**:, > Tip:, > **Warning:**, etc.) across the docs to the GitHub markdown alert syntax ([!NOTE], [!TIP], [!WARNING], [!IMPORTANT]) that tanstack.com renders as styled callouts. Also fixes one pre-existing alert in client-side-vs-server-side.md that had its content on the same line as the marker, and trailing whitespace on the alert marker in the svelte quick-start. Qualified callouts with custom titles (TypeScript Note, Framework note, Naming note) are intentionally left as plain blockquotes since the alert syntax does not support custom titles. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
mootari
commented
Aug 13, 2026
|
|
||
| > Note: a drag emits one change per cell boundary the pointer crosses, so `onCellSelectionChange` fires repeatedly during a drag. If you are syncing selection to a server or a URL, debounce it or commit on `mouseup`. | ||
| > [!NOTE] | ||
| > a drag emits one change per cell boundary the pointer crosses, so `onCellSelectionChange` fires repeatedly during a drag. If you are syncing selection to a server or a URL, debounce it or commit on `mouseup`. |
Contributor
Author
There was a problem hiding this comment.
Nit: Should start with an uppercase letter (there are a few more places).
mootari
changed the title
mootari
marked this pull request as ready for review
August 13, 2026 13:58
KevinVandy
approved these changes
Aug 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Changes
The callout at the start of https://tanstack.com/table/latest/docs/framework/svelte/quick-start currently uses a plain blockquote, which causes it to get wrapped in additional quotes.
This PR matches the markup to what is used in the devtools docs, with the assumption that it is also supported in the table docs.
The change was made through GitHub's editor and not tested locally.
✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit