Skip to content

fix(website): make changelog posts look nice - #4788

Merged
sxlijin merged 3 commits into
canaryfrom
sxlijin/website-baml-highlighting
Sep 9, 2026
Merged

sxlijin merged 3 commits into
canaryfrom
sxlijin/website-baml-highlighting

Conversation

@sxlijin

@sxlijin sxlijin commented Sep 9, 2026 •

Copy link
Copy Markdown
Contributor

Add in BAML syntax highlighting (Shiki is how we package the textmate grammar) and fix the vertical spacing on changelog posts.

@coderabbitai

coderabbitai Bot commented Sep 9, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Advanced

Run ID: 0c6343c9-c93b-43e7-bbd3-66e708e2f52c

📥 Commits

Reviewing files that changed from the base of the PR and between 9a1e426 and ffcc25b.

📒 Files selected for processing (1)
  • typescript2/app-website/package.json
💤 Files with no reviewable changes (1)
  • typescript2/app-website/package.json

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The website now highlights supported MDX code fences with Shiki, including BAML grammar support. Blog content uses narrower containers and revised heading and author spacing.

Changes

Website MDX highlighting

Layer / File(s) Summary
MDX highlighting pipeline
typescript2/app-website/lib/mdx/rehype-highlight-code.ts, typescript2/app-website/lib/mdx/remark-code-metadata.ts, typescript2/app-website/app/blog/[slug]/content.tsx, typescript2/app-website/package.json
The rehype pipeline highlights BAML and bundled Shiki languages, preserves code metadata, and skips unsupported or non-text blocks.
Blog layout and prose styling
typescript2/app-website/app/blog/[slug]/page.tsx, typescript2/app-website/app/blog/[slug]/content.tsx, typescript2/app-website/app/globals.css
Blog containers use max-w-screen-md. Blog prose receives explicit heading margins and updated wrapper spacing.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to f6309

The update adds server-side code highlighting and blog spacing adjustments. No concrete merge-blocking risk is established by the supplied change context.

Sequence Diagram(s)

sequenceDiagram
  participant MDXPipeline
  participant rehypeHighlightCode
  participant Shiki
  participant BlogPage
  MDXPipeline->>rehypeHighlightCode: visit supported code fences
  rehypeHighlightCode->>Shiki: request BAML or bundled language highlighting
  Shiki-->>rehypeHighlightCode: return highlighted HAST
  rehypeHighlightCode->>BlogPage: preserve metadata and render highlighted code
Loading
🚥 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 4 functions across 5 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies the website changelog and blog rendering changes, although it uses informal wording.
Full details: Docstring Coverage

Explanation

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 4 functions across 5 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sxlijin/website-baml-highlighting

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

A rabbit found code in the moonlit night
Shiki made every syntax bright
BAML hopped in with grammar neat
Narrow blog walls made pages sweet
Headings settled in their place
The post wore highlights with grace

Comment @coderabbitai help to get the list of available commands.

@vercel

vercel Bot commented Sep 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
baml-website Ready Ready Preview Sep 9, 2026 6:57pm UTC
beps Ready Ready Preview Sep 9, 2026 6:57pm UTC
developer-docs Ready Ready Preview Sep 9, 2026 6:57pm UTC
promptfiddle2 Ready Ready Preview Sep 9, 2026 6:57pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 9, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-09T02:58:14.434181Z e22eeb2 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

⏭️ Performance benchmarks were skipped

Perf benchmarks (CodSpeed) are opt-in on pull requests — they no longer run on every push. They always run automatically after merge to canary/main.

To run them on this PR, do any of the following, then push a commit (or re-run CI):

  • Add RUN_CODSPEED=1 to the PR description, or
  • Include run-perf or /perf in the PR title or any commit message.

@sxlijin
sxlijin removed this pull request from stack #4792 September 9, 2026 18:48
@sxlijin
sxlijin changed the base branch from sxlijin/changelog-0.19.0 to canary September 9, 2026 18:48
@sxlijin
sxlijin force-pushed the sxlijin/website-baml-highlighting branch from ffcc25b to f63097f Compare September 9, 2026 18:48
@sxlijin
sxlijin added this pull request to stack #4793 September 9, 2026 18:49
@sxlijin sxlijin changed the title fix(web): highlight blog code and clean up article spacing fix(web): make changelog posts look nice Sep 9, 2026
@sxlijin sxlijin changed the title fix(web): make changelog posts look nice fix(website): make changelog posts look nice Sep 9, 2026
@sxlijin
sxlijin removed this pull request from stack #4793 September 9, 2026 18:56
@sxlijin
sxlijin added this pull request to the merge queue Sep 9, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to no response for status checks Sep 9, 2026
@sxlijin
sxlijin added this pull request to the merge queue Sep 9, 2026
Merged via the queue into canary with commit d7a9562 Sep 9, 2026
44 checks passed
@sxlijin
sxlijin deleted the sxlijin/website-baml-highlighting branch September 9, 2026 21:49

This branch was successfully deployed

4 active (1 outdated) deployments
Preview – promptfiddle2 — f63097f0 Deployed Sep 9, 2026 by vercel[bot]
Preview – beps — f63097f0 Deployed Sep 9, 2026 by vercel[bot]
Preview – developer-docs — f63097f0 Deployed Sep 9, 2026 by vercel[bot]
Preview – baml-website — 9a1e426a Deployed Sep 9, 2026 by vercel[bot]
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