Skip to content

chore(docs): upgrade the docs site to Nimbus 0.19.0 - #68

Draft
MohamedH1998 wants to merge 1 commit into
mainfrom
feat/api-site-nimbus-0-19
Draft

MohamedH1998 wants to merge 1 commit into
mainfrom
feat/api-site-nimbus-0-19

Conversation

@MohamedH1998

Copy link
Copy Markdown
Collaborator

Summary

Upgrades cloudflare-api-site from Nimbus 0.18 to 0.19.0. Nothing changes for readers. The build no longer emits getStaticPaths() warnings, and agent discovery files (llms.txt, .well-known/ard.json, sitemap) are served under /api.

API pages are still drawn by astro-fern and fern-forge; moving them to Nimbus is a separate change.

Changes

  • @cloudflare/nimbus-docs ^0.18.0 → ^0.19.0; nimbus.json records 0.19.0 as reviewed.
  • Route files follow the site's rendering: { default: 'request' } (nimbus-docs check --fix): prerender and getStaticPaths exports removed from [...slug].astro, [...slug]/index.md.ts, [...slug]/index.mdx.ts and llms-full.txt.ts, with the stale comment and unused import that went with them.
  • description-markdown.ts now escapes only what Nimbus 0.19.0 still drops from descriptions used as text: HTML comments and <script>. Nimbus keeps metadata.<key>-style placeholders itself, so the module no longer handles them and is renamed keepDroppedHtml. Edge cases with no occurrence in the current spec now render as Nimbus does: a stray closing tag is dropped, and an unknown tag that opens an HTML block is no longer wrapped in <p>.
  • Lockfile: the Nimbus bump and its transitive updates, plus zod resolved to one version (4.6.7) for the whole workspace. The site's and astro-fern's copies of astro/zod already disagreed on main; 0.19.0's type check surfaced it. No manifest outside the site changed.
  • pnpm-workspace.yaml: pnpm's automatic minimumReleaseAgeExclude entry for the new version.

0.19.0 upgrade entries (17): route-files-follow-rendering applied. Optional and skipped: lighter-sidebar-rows, redesigned-starter, favicons-and-asset-caching, connect-mcp, agent-discovery-opt-out (the Worker owns its host), pnpm-sharp, collection-urls-from-routes. Not applicable: changelog-release-notes, og-font-path, branded-share-cards, search-provider-slices, api-home, api-code-rail-lines, api-sidebar-alignment, card-links, diagram-controls-height.

Validation

Before and after builds used the same spec (FORGE_OPENAPI_RELEASE=openapi@e2386f5f).

Passed locally:

  • Root pnpm check, pnpm typecheck, pnpm test.
  • Site: pnpm test (134), astro check (0 errors), nimbus-docs check (all ok), nimbus-docs migrate reports nothing pending, cf build with 0 getStaticPaths() warnings (3 before), test:e2e (19), test:visual (28, against a baseline taken on 0.18).
  • Route list identical: 3,040 operation, authored, command and agent routes.
  • Ten named pages and their Markdown twins identical apart from per-build hashes: overview, six operations across three products (one with ?lang=terraform), a command page, llms.txt, a 404.
  • Descriptions: the 9 placeholder samples identical; old and new renderers compared over all 27,007 description, summary and title strings in the pinned spec and Terraform docs with 0 differences.
  • Discovery: every link in /api/llms.txt resolves; /api/.well-known/ard.json and /api/sitemap-index.xml served.

Pending: the deploy preview for this PR.

Pre-existing and unchanged: nimbus-docs check notes @astrojs/cloudflare@15.0.0-beta.2 is newer than the version Nimbus declares support for.

@MohamedH1998 MohamedH1998 changed the title Upgrade the API site to Nimbus 0.19.0 chore(docs): upgrade the docs site to Nimbus 0.19.0 Oct 23, 2026
@pkg-pr-new

pkg-pr-new Bot commented Oct 23, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/cloudflare/forge/@cloudflare/forge@68

commit: b6a784e

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