Repository navigation
Upgrade Nimbus to 0.18.1 and add nimbus.json baseline - #365
Merged
Merged
Conversation
The Nimbus site was adopted from the monorepo POC in one bulk commit rather than scaffolded with create-nimbus-docs, and its components were copied in by hand instead of installed with `nimbus-docs add`, so no nimbus.json was ever written. Without it `nimbus-docs outdated` has no baseline and every Nimbus upgrade is a manual diff. Generate the record with `nimbus-docs init`: 28 registry components recorded, 5 byte-identical to registry release 0.18.1 (button, card, card-grid, popover, cn) and 23 locally modified. Starter provenance (version, templatesTag, variant) is left null and flagged `reconstructed` because the starter files were never taken from a templates tag. Hide nimbus.json from Mintlify alongside the other Nimbus tooling files and document the file and the `outdated` command in src/README.md. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Bump @cloudflare/nimbus-docs 0.13.1 -> 0.18.1 (ten releases, 2026-09-07 to 2026-10-14) and @astrojs/markdown-satteri ^0.3.8 -> ^0.4.3. The newer Nimbus requires a Sätteri processor that exposes `createMdxRenderer`, which only the 0.4 line provides; without the bump `astro:config:setup` throws. Drop the local dist patch and the pnpm `satteri` override. pnpm keys the patch to the exact 0.13.1 version, and every fix it carried is upstream now: UTF-16 offset mapping, `<PLACEHOLDER>` parsing, heading-id and math features read from the processor, and import/comment/raw-tag stripping in generated Markdown. Verified by building the placeholder, emoji and math pages unpatched. Record 0.18.1 as the reviewed upgrade baseline in nimbus.json via `nimbus-docs migrate --from 0.13.1`; 0.18 refuses to build without it. The ten required reviews are all OpenAPI or versioning features this site does not use, except explicit-markdown-processor, which the Sätteri bump satisfies. Guard `page.markdownHref` in ApiBody.astro (optional since 0.18) and keep the new root-level `_headers` and `.well-known/` output beside `__redirects` instead of nesting them under /docs: Workers static assets only honour `_headers` at the asset root, and the discovery documents are addressed at the origin root. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
🕵
|
Member
Author
Blargian
marked this pull request as ready for review
October 15, 2026 10:51
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.
Summary
Upgrades
@cloudflare/nimbus-docsfrom the pinned 0.13.1 to 0.18.1 (ten releases) and establishes thenimbus.jsonbaseline the CLI needs to track future upgrades. Two commits:nimbus-docs initover the adopted site: 28 registry components recorded (5 byte-identical to registry 0.18.1, 23 locally modified). Also hides the file from Mintlify and documents it insrc/README.md.What the upgrade changes
@cloudflare/nimbus-docs0.13.1 → 0.18.1@astrojs/markdown-satteri^0.3.8 → ^0.4.3createMdxRenderer; 0.3.x lacks it andastro:config:setupthrowspatches/@cloudflare__nimbus-docs@0.13.1.patchand thesatterioverride<PLACEHOLDER>parsing, heading-id/math features, import/comment/raw-tag stripping in generated Markdown). Verified by building the placeholder, emoji and math pages unpatchednimbus.jsongainslastReviewedNimbusVersion: 0.18.1nimbus-docs migrate --from 0.13.1; 0.18 refuses to build without a reviewed baselineApiBody.astro: guardpage.markdownHrefPageActionsalready acceptsundefinedbin/postbuild.ts: keep_headersand.well-known/at the output root_headersat the asset root; the discovery documents are addressed at the origin rootThe ten required migrate reviews were assessed: all concern OpenAPI
apientries, API versioning, coordinate manifests, or.well-knownownership, none of which this site configures, exceptexplicit-markdown-processor, which the Sätteri bump satisfies.Verification (English,
DOCS_REMOTES=none, fullpnpm buildincl. postbuild, after mergingmainwith #366){#id}anchors present/docs, 0/docs/docs/.assetsignore .well-known __redirects _headers docs— nothing nested twicepnpm typecheckwrangler deploy --dry-runFrontmatter blocker (resolved by #366)
The new markdown-satteri parses frontmatter with the spec-strict
yamlpackage (via@astrojs/internal-helpers0.12), where Astro's own path used lenient js-yaml. 15 English pages and 113 locale copies had a quoted frontmatter string wrapped onto a column-0 continuation line, which is invalid YAML and failed content sync on 0.18. #366 rejoined those strings and is merged;mainhas been merged into this branch, so the full build above includes every page.Follow-ups (not in this PR)
llms.txtpages were "not prerendered": this repo publishes/<page>.mdwhere Nimbus expects/<page>/index.md. Noise until the routes are reconciled..well-known/ard.jsonandai-catalog.jsonare advertised athttps://clickhouse.com/.well-known/…; the website Worker needs to forward those paths for them to resolve.markdown.features+markdown.hastPluginsnow exist upstream, so the custom Sätteri processor and the vendoredNimbusHead.astro(base-path issues docs: port "achieving atomic inserts" knowledgebase page #105/Docs: sync upstream clickhouse-operator docs updates #78 are closed) can likely be retired.math()hast plugin is available for MathML; math currently renders as untypesetcode.language-math.bin/fetch-remotes.tswithDOCS_REMOTES=nonedeletes the tracked dbt mount directory andgen-sidebarrewritesreports/nav-vs-disk.md; both needgit checkout --after a local build.🤖 Generated with Claude Code