Skip to content

docs: refresh Highlight landing page for 0.0.11 - #1255

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

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

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Sep 11, 2026 •

Copy link
Copy Markdown
Member

Update Highlight's landing page for 0.0.11 with current bundle sizes and benchmark results, supported languages, a valid API example, correct Vue registrations, and valid fence annotation syntax. Link the benchmark to its methodology and document the available Markdown integrations.

Remove repeated section labels, with optional labels in the shared section component so existing landing pages keep their current presentation.

Validation: full pnpm test passes, including both TypeScript checks, lint, and 503 unit tests (2 skipped). Browser review confirmed the examples and benchmark layout, and the comparison link opens the docs. Bundle sizes were measured against Highlight 0.0.11.

Related documentation changes: TanStack/highlight#15 (merged).

Summary by CodeRabbit

  • Content Updates
    • Updated the Highlight landing page with refreshed bundle profiles, language listings, and section content.
    • Simplified section introductions by removing unused labels and icons.
    • Updated the CodeLab example with current syntax highlighting options and line numbers.
    • Refreshed benchmark figures and added a link to the project benchmark report.
  • UI Improvements
    • Landing section headings now support optional labels and adjust spacing automatically when labels are omitted.

@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: 1b12f232-0bcb-4cc1-8849-f790049ebc24

📥 Commits

Reviewing files that changed from the base of the PR and between f2f65d1 and 30090d4.

📒 Files selected for processing (2)
  • src/components/landing/HighlightLanding.tsx
  • src/components/landing/LibraryLanding.tsx

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


📝 Walkthrough

Walkthrough

The PR updates the Highlight landing page with revised section content, bundle data, CodeLab API usage, embedded-language labels, and benchmark measurements. LandingSectionIntro now supports sections without eyebrow labels.

Changes

Highlight landing page

Layer / File(s) Summary
Section content and intro rendering
src/components/landing/LibraryLanding.tsx, src/components/landing/HighlightLanding.tsx
LandingSectionIntro renders optional eyebrows. Highlight sections use updated descriptions, language groups, integrations, and icon imports.
CodeLab API example
src/components/landing/HighlightLanding.tsx
The sample uses the language-specific tsx import, createHighlighter, highlighter.highlight, and lineNumbers.
Metrics and benchmark presentation
src/components/landing/HighlightLanding.tsx
Bundle, embedded-language, annotation, and benchmark displays use updated labels and measurements. The benchmark footer links to the project report.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Other

Suggested reviewers: sukvvon

Merge Risk: ⚪ Minimal · up to 30090

The landing-page refresh updates presentation content and examples without an established functional regression.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 2 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation update to the Highlight landing page for version 0.0.11. This matches the main changes and objectives.
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.
  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/highlight-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.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 11, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com 30090d4 Commit Preview URL

Branch Preview URL
Sep 11 2026, 07:59 PM

@tannerlinsley
tannerlinsley merged commit 18b21d0 into main Sep 11, 2026
6 of 7 checks passed
@tannerlinsley
tannerlinsley deleted the taren/highlight-docs-refresh branch September 11, 2026 20:00
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