fix(docs): stop repeating the version as the release headline - #3054
Merged
Conversation
The /releases page rendered every entry as "1.1.0 Minor – 1.1.0" and then
repeated the real headline as an h2 right below it.
The title came from the GitHub Release `name`, and the publish workflow sets
that to the bare version (`gh release create --title "${tag}"`). The
`name?.trim() || version` fallback only caught an *empty* name, so a name that
equals the version slipped through. The curated headline actually lives as the
body's leading H1 — which `headingOffset={1}` then emitted as a second h2.
Take that leading H1 as the title and strip it from the body. `name` stays as a
fallback for a hand-titled Release, and `title` is now optional: with no
headline the heading shows the version alone instead of doubling it.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
`docs:test:unit` has been red since #2988: the new `MdxFile.test.ts` uses `node:test`, so vitest picks it up, cannot collect it, and fails with "No test suite found" — while `test:links`, which runs the `node:test` files, never saw it. Rename it to `.node.test.ts`. The two globs are deliberately disjoint, as the comment in `apps/docs/vitest.config.ts` documents. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
Coverage Report for ./packages/components/
File CoverageNo changed files found. |
Contributor
🚀 Preview DeploymentPreview environments are ready:
Images:
|
ins0
approved these changes
Sep 1, 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
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.
What & why
The
/releasespage rendered every entry as "1.1.0 Minor – 1.1.0" and thenrepeated the real headline as an
h2right below it.The title came from the GitHub Release
name, and the publish workflow sets thatto the bare version (
gh release create --title "${tag}",publish.yml:597).The
name?.trim() || versionfallback only caught an empty name, so a namethat equals the version slipped through. The curated headline actually lives as
the body's leading
H1— whichheadingOffset={1}then emitted as a secondh2.splitHeadline()now takes that leadingH1as the title and strips it from thebody. Only a leading
H1counts; a#further down belongs to the notes.namestays as a fallback for a hand-titled Release, andtitleis optional:with no headline the heading shows the version alone instead of doubling it.
Fixing this docs-side (rather than in
publish.yml) also repairs the tworeleases that are already published.
Before → after, against live GitHub data:
1.1.01.1.0 Minor – 1.1.01.1.0 Minor – Upgrade across Flow versions with one command1.0.01.0.0 Major – 1.0.01.0.0 Major – Semantic Versioning is a promise now, not an intentionHeading hierarchy in the prerendered
apps/docs/out/releases.htmlis clean now —previously the headline sat as a stray
h2between the releases:Second commit: a red test on
maindocs:test:unithas been failing since #2988: the newMdxFile.test.tsusesnode:test, so vitest picks it up, cannot collect it, and fails with "No testsuite found" — while
test:links, which runs thenode:testfiles, never sawit. Renamed to
MdxFile.node.test.ts; the two globs are deliberately disjoint,as the comment in
apps/docs/vitest.config.tsdocuments. Without it this PR'sown
docs:test:unitrun would be red.Verification
pnpm affected:test— green (10 projects, 35 tasks)pnpm nx test:unit docs— 18 passed (4 new forsplitHeadline)pnpm nx test:links docs— green, now includingMdxFile.titleFromtsc --noEmitclean,pnpm lint0 errorspnpm nx build docsand the resultingout/releases.htmlchecked against thelive release data
No screenshot:
preview_startresolves.claude/launch.jsonfrom the maincheckout, so a worktree session cannot start the docs dev server. The
prerendered HTML is what ships, so it was verified there instead.
Checklist
pnpm lintis clean andpnpm affected:testpasses (browser tests ifbehavior changed)
de-DEanden-USlocale files (n/a— release notes come from GitHub, page chrome unchanged)
updated snapshots / the
update-screenshotslabel (n/a —apps/docsonly,not covered by the visual suite)
🤖 Generated with Claude Code