Skip to content

docs: refresh Markdown compatibility and measurements - #16

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/markdown-docs-refresh
Sep 11, 2026
Merged

tannerlinsley merged 1 commit into
mainfrom
taren/markdown-docs-refresh

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Sep 11, 2026

Copy link
Copy Markdown
Member

Refresh the Markdown docs for v0.0.14. Correct the React and Octane bundle measurements and CommonMark compatibility count, document the improved list, reference, table, and code-span behavior, and link repository reports directly to GitHub so they work on tanstack.com.

Validation: all 27 documentation pages and public exports verified, build passed, and all 78 targeted compatibility tests passed.

Summary by CodeRabbit

  • Documentation
    • Updated report links to direct GitHub URLs.
    • Clarified Markdown parsing behavior for reference labels, repeated definitions, lists, tables, inline code, and reference links/images.
    • Updated bundle-size information, including a separately reported UI adapter size of 6.6 KB.
    • Revised CommonMark compatibility reporting to 403 of 652 examples for version 0.0.14.

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 5895afc1-dfcf-428d-a530-64a712cfdb5b

📥 Commits

Reviewing files that changed from the base of the PR and between 419df84 and fc4b9f2.

📒 Files selected for processing (8)
  • docs/comparison.md
  • docs/core-concepts/parsing.md
  • docs/core-concepts/rendering.md
  • docs/core-concepts/syntax-profile.md
  • docs/guides/performance.md
  • docs/guides/testing.md
  • docs/overview.md
  • docs/project/faq.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

Documentation updates replace relative report links, revise bundle and conformance figures, and clarify reference-label, list, block-syntax, and inline-syntax behavior.

Changes

Documentation updates

Layer / File(s) Summary
Report links and figures
docs/comparison.md, docs/guides/performance.md, docs/overview.md, docs/project/faq.md
Report references now use absolute GitHub URLs. The overview lists the UI adapter separately at 6.6 KB. The FAQ reports 403 of 652 matching CommonMark examples for v0.0.14.
Markdown behavior descriptions
docs/core-concepts/parsing.md, docs/core-concepts/rendering.md, docs/core-concepts/syntax-profile.md
The documentation describes normalized reference labels, first-definition precedence, zero-based ordered-list starts, nested-list looseness, escaped table pipes, preserved inline-code whitespace, and shortcut reference forms.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to fc4b9

The documentation refresh introduces no unresolved merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation updates to Markdown compatibility information and measurement data. It matches the main changes in the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/markdown-docs-refresh

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.

@tannerlinsley
tannerlinsley merged commit fca831e into main Sep 11, 2026
3 of 4 checks passed
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