Skip to content

Commit fc86a6b

Browse files
committed
upgrading packages/astro
Assisted-by: Claude Code
1 parent b704d66 commit fc86a6b

34 files changed

Lines changed: 860 additions & 1022 deletions

File tree

‎AGENT.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ public/assets/images/ # images, shared by all versions, referenced as
6262
resources/nimbus/ # convert.py, its tests, templates, per-version overrides, parity.sh
6363
resources/og/card.html # the layout of the social cards (the cards of phalcon/assets), see README.md
6464
scripts/ # new-version.sh, update-nfr.mjs, update-tokens.mjs (the design files), token-sources.mjs (the tokens that src/ uses), og-cards.mjs, render-og-cards.mjs, check-og.mjs (the social cards)
65-
patches/ # nimbus patch that allows the dot in `docs-5.20`
6665
```
6766

6867
**Do not edit a generated file.** `src/content.config.ts`, `src/versions.generated.mjs`, `src/sidebar/*`, `src/redirects/*` and `src/pages/<version>/*` are written by `resources/nimbus/convert.py`; the route files come from `resources/nimbus/templates/*.tpl`. Change the template or the converter, then run `convert.py --register` again:
@@ -110,7 +109,7 @@ Rules:
110109
| Convert a MkDocs version | `convert.py --version <v> --source <checkout>/docs --nav <checkout>/mkdocs.yml --skip-locale-redirects`, then `convert.py --register`. Every version is converted already; the converter stays for a branch still in MkDocs form. Replace a converted page by hand from `resources/nimbus/overrides/` (see its README). |
111110
| Compare with the old site | `resources/nimbus/parity.sh <version>` - URLs and heading ids of `dist/<version>` against `gh-pages/<version>`. |
112111
| Install a registry component | `pnpm exec nimbus-docs add <slug>`, then register it in `src/components.ts` if `.mdx` uses it. |
113-
| Upgrade nimbus | Re-check `patches/@cloudflare__nimbus-docs@<version>.patch` (it allows the dot in a collection key). `pnpm exec nimbus-docs outdated`, `diff <file>`, `add <slug> --overwrite`. |
112+
| Upgrade nimbus | Set the version in `package.json` and install. `pnpm exec nimbus-docs migrate --dry-run` lists the reviews since the version in `nimbus.json`. Do each one that applies, then `pnpm exec nimbus-docs migrate --yes`: the build stops until `nimbus.json` records the new version. Compare the build with the build before the upgrade, also the Markdown copies (`/<version>/<slug>/index.md`). `pnpm exec nimbus-docs outdated`, `diff <file>`, `add <slug> --overwrite` for the starter files and the registry components. |
114113

115114
## Verify before you claim
116115

@@ -126,7 +125,7 @@ To compile-check MDX without a full build, run `@mdx-js/mdx`'s `compile()` over
126125

127126
## Deployment
128127

129-
A push to `master` runs `.github/workflows/deploy-documents.yml`: install (which applies the patch) → `update-nfr` → get the shared design tools (`src/lib/design-checks.mjs`, `src/lib/design-refresh.mjs`) from `phalcon/assets` → refresh `src/styles/tokens.css` and `src/styles/code-theme.json` from `phalcon/assets` (`scripts/update-tokens.mjs`) → `test` → refresh `src/fanart.html` from `phalcon/assets` → `build` → publish `dist/` to the branch named by `DEPLOY_BRANCH` (`production`), which Cloudflare Pages serves → point the `/latest/` redirect rule at `STABLE_VERSION`. The `gh-pages` branch holds the last MkDocs deployment as the rollback: point the Pages production branch back at it.
128+
A push to `master` runs `.github/workflows/deploy-documents.yml`: install → `update-nfr` → get the shared design tools (`src/lib/design-checks.mjs`, `src/lib/design-refresh.mjs`) from `phalcon/assets` → refresh `src/styles/tokens.css` and `src/styles/code-theme.json` from `phalcon/assets` (`scripts/update-tokens.mjs`) → `test` → refresh `src/fanart.html` from `phalcon/assets` → `build` → publish `dist/` to the branch named by `DEPLOY_BRANCH` (`production`), which Cloudflare Pages serves → point the `/latest/` redirect rule at `STABLE_VERSION`. The `gh-pages` branch holds the last MkDocs deployment as the rollback: point the Pages production branch back at it.
130129

131130
## Don't
132131

‎nimbus.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,6 @@
3737
"src/components/ui/version-switcher/index.ts"
3838
]
3939
}
40-
]
40+
],
41+
"lastReviewedNimbusVersion": "0.17.0"
4142
}

‎package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
"update-nfr": "node scripts/update-nfr.mjs"
1616
},
1717
"dependencies": {
18-
"@cloudflare/nimbus-docs": "0.11.0",
18+
"@cloudflare/nimbus-docs": "0.17.0",
1919
"@iconify-json/ph": "^1.2.0",
20-
"astro": "~7.0.9",
20+
"astro": "~7.3.8",
2121
"clsx": "^2.1.1",
22-
"mermaid": "^11.17.2",
22+
"mermaid": "^12.1.0",
2323
"tailwind-merge": "^3.5.0"
2424
},
2525
"devDependencies": {

‎patches/@cloudflare__nimbus-docs@0.11.0.patch‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)