Skip to content

docs(web): make the 4.2 guides, API reference and home page links current - #4322

Merged
bpamiri merged 7 commits into
developfrom
peter/guides-4-2-current
Oct 11, 2026
Merged

bpamiri merged 7 commits into
developfrom
peter/guides-4-2-current

Conversation

@bpamiri

@bpamiri bpamiri commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Do not merge before the 4.2.0 release cut. This is the step that makes 4.2 the current docs line on guides.wheels.dev, api.wheels.dev and wheels.dev. It merges after #4550, which adds the v4-2-0 API tree this PR lists.

  • web/packages/ui/src/data/versions.ts:
    • GUIDES_VERSIONS: v4-2-0 changes from snapshot / "v4.2 (in development)" to current / "v4.2 (current)", expanded. v4-1-0 becomes archived / "v4.1", collapsed.
    • API_VERSIONS: v4-2-0 is added as current / "v4.2 (current)". v4-1-0 becomes archived / "v4.1", collapsed.
    • Both mirror the 4.1.0 flip in chore(release): prepare the 4.1.0 changelog and documentation #3621.
  • web/sites/guides/src/content/docs/index.md: lists v4.2 as the current release and v4.1 as archived.
  • web/sites/api/src/content/docs/index.md: the versions table lists v4.2.0 (406 functions) as the current release.
  • web/sites/landing/src/pages/index.astro: the Get started button and the Guides and API cards link v4-2-0.

Not in this PR:

  • Docs bundle version: tools/build/scripts/build-docs.sh picks each list's first slug, not its status.
  • GuidesLink: already links 4.2 (fix(cli): link the 4.2 guides from GuidesLink and stop its latest version falling behind #4161).
  • Doc checks: verify-docs.mjs's DEFAULT_TARGET and the docs-verify.yml paths already cover v4-2-0.
  • Contributor docs: contributing/writing-docs.mdx still says 4.2 is "in development". It gets reworded with the v4-3-0 guides tree that follows the tag.

🤖 Generated with Claude Code

Flip GUIDES_VERSIONS so v4-2-0 is the current line and v4-1-0 is
archived, and update the guides landing page to match. For the 4.2.0
release cut.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
bpamiri and others added 2 commits October 11, 2026 11:35
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
API_VERSIONS lists v4-2-0 as current and v4-1-0 as archived; the API index
table and the wheels.dev home page links move to v4-2-0. Needs the v4-2-0
API tree to be on develop first.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri bpamiri changed the title docs(web): mark the 4.2 guides current docs(web): make the 4.2 guides, API reference and home page links current Oct 11, 2026
@bpamiri
bpamiri marked this pull request as ready for review October 11, 2026 18:44
@bpamiri

bpamiri commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator Author

Pre-review at 00540ec (draft): the content is right, but the head doesn't include #4550 yet, so it's not mergeable as is.

  • Blocking until develop is merged in. API_VERSIONS now lists v4-2-0 as current, and the API index links /v4-2-0/ (406 functions). This head predates docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree #4550 (c1e1f81e5 isn't an ancestor), so web/sites/api/src/content/docs/ has no v4-2-0 tree. The API site would make a non-existent version current, and its index link and version picker entry would be dead. After the planned develop merge brings in docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree #4550, this resolves.
  • The rest checks out against the per-minor policy:
    • GUIDES_VERSIONS / API_VERSIONS: v4-2-0 becomes the single current entry (expanded); v4-1-0 becomes archived (collapsed) and stays listed, so 4.1 remains reachable in the picker; older entries are unchanged.
    • The guides and API index pages promote v4.2 to current release and keep v4.1 as a plain archived link.
    • The landing page's three v4-1-0 CTAs/resources move to v4-2-0.
    • Outside the versioned trees, the only v4-1-0 references left are fixtures and archived-sidebar paths (check-llms.test.mjs, GuidesLinkSpec, NewCommandTemplateSpec, sidebars/v4-1-0.json). The wheels new templates already link v4-2-0.

I'll do the final once develop (with #4550) is merged in and PR CI's Deploy api / guides / landing builds and Visual regression have run on that head.

Manually triggered baseline refresh via
.github/workflows/refresh-visual-baselines.yml
targeting branch peter/guides-4-2-current.

Run when an intentional content/layout change makes the visual-regression
check fail. The new PNG(s) under web/tests/visual-baselines/ are now the
expected rendering.
@bpamiri

bpamiri commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator Author

Review at 9c2319d: the content is approved, but this head has no CI yet.

  • The blocking point is resolved. The branch now includes docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree #4550 (c1e1f81e5), so the v4-2-0 API tree exists and making it current is safe. Apart from the bot's api.png baseline refresh, the change set is identical to the one I pre-reviewed. The policy checks hold: one current per manifest, v4.1 archived but listed, and the index and landing links flipped.
  • CI at the merge commit bcc6d62aa:
    • Deploy api / guides / landing / blog / packages, CLI suite, Lucee 7 + SQLite (LuCLI), RustCFML (Linux), Tutorial E2E and the web/scripts node tests all pass.
    • Visual regression failed there, because the API index's version table changed, and the bot then pushed 9c2319dee refreshing web/tests/visual-baselines/api.png. The "Refresh guides baseline(s)" job was cancelled.
  • No checks on the current head. 9c2319dee was pushed by github-actions[bot] with GITHUB_TOKEN, which doesn't trigger workflows, so gh pr checks reports "no checks" and the merge state is BLOCKED.
    • Push an empty commit from a human seat (e.g. chore: trigger CI after the baseline refresh) whose tree equals 9c2319dee's, so Visual regression and the deploy builds run on the refreshed baseline

I'll give the final as soon as that head's checks are green, Visual regression in particular, confirming that the guides baseline needs no refresh.

github-actions Bot and others added 2 commits October 11, 2026 18:52
Manually triggered baseline refresh via
.github/workflows/refresh-visual-baselines.yml
targeting branch peter/guides-4-2-current.

Run when an intentional content/layout change makes the visual-regression
check fail. The new PNG(s) under web/tests/visual-baselines/ are now the
expected rendering.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri

bpamiri commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator Author

Final review: head 2559166. APPROVE (ready to merge for the 4.2.0 cut).

  • Content (unchanged since the review at 9c2319d, and includes docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree #4550's v4-2-0 API tree):
    • GUIDES_VERSIONS / API_VERSIONS make v4-2-0 the single current entry, and v4.1 moves to archived but stays listed, so it's reachable;
    • the guides and API index pages and the landing page's guides/API links point at v4.2;
    • no stray v4-1-0 links remain outside fixtures and the archived sidebar.
  • Baselines:
    • api.png (bot, 9c2319d) differs only in the API index's version table;
    • guides.png (bot, 46a992f) differs only in the version sidebar: "V4.2 (current)" expanded at the top, v4.1 collapsed. The page body, header and TOC are identical to the previous baseline.
    • 2559166 is an empty human commit whose tree equals its parent's, so CI runs on the refreshed baselines.
  • PR CI at 2559166: 20 pass, 0 fail, 3 skipped. That includes Deploy api / guides / landing / blog / packages, Visual regression and the web/scripts node tests. Merge state is CLEAN.

@bpamiri
bpamiri merged commit ef1ef0b into develop Oct 11, 2026
23 checks passed
@bpamiri
bpamiri deleted the peter/guides-4-2-current branch October 11, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs javascript Pull requests that update javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant