Skip to content

docs: upgrade guide site to @nebari/starlight v0.2.0#21

Merged
dcmcand merged 1 commit into
mainfrom
docs/update-nebari-starlight-v0.2.0
Jul 7, 2026
Merged

docs: upgrade guide site to @nebari/starlight v0.2.0#21
dcmcand merged 1 commit into
mainfrom
docs/update-nebari-starlight-v0.2.0

Conversation

@dcmcand

@dcmcand dcmcand commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

What

Updates the guide site (docs/site) to the shared @nebari/starlight theme v0.2.0.

The theme's own API is unchanged (same nebari({ logoHref }) plugin, no internal imports on our side), but v0.2.0 raises its Astro peer floor to >=7.0.6. That turns the bump into a framework upgrade, so this moves to the exact versions the theme author built v0.2.0 against:

Package Before After
@nebari/starlight ^0.1.6 ^0.2.0
astro ^5.0.0 ^7.0.6
@astrojs/starlight ^0.33.0 ^0.41.3
@astrojs/markdown-remark (transitive) ^7.2.1 (now direct)

Changes

  • astro.config.mjs: Astro 7 deprecated the top-level markdown.rehypePlugins field. Migrated the rehype-base-links pass to the official unified({ rehypePlugins: [...] }) processor from @astrojs/markdown-remark (GFM and SmartyPants stay on by default). This clears the build's only deprecation warning.
  • test/build.test.ts: v0.2.0 redesigned the theme's typography. Headings are now Space Grotesk rather than Poppins, and the accent maps through --nbr-brand (a magenta-violet derived from --nbr-primary) instead of --nbr-primary directly. Updated the Journey 4 branding assertions to match the theme's actual output; the test's intent is unchanged.
  • package.json / bun.lock: version bumps above.

Verification

  • bun run build: clean, no deprecation warnings, 8 pages.
  • bun test: 11/11 pass (355 assertions).
  • bun install --frozen-lockfile: clean, so the docs CI's frozen install stays green.
  • Builds succeed on both the production subpath (/building-a-software-pack/) and the PR-preview root base (BASE_PATH=/), and root-base links resolve correctly through the new unified() wiring.

Local Node is 22.22 (Astro 7 requires >=22.12) and the docs workflow runs on Bun latest, so there is no runtime pin to bump. The Cloudflare Pages preview deploy from this PR is the last check.

The shared theme's v0.2.0 raises its Astro peer floor to >=7.0.6, so the
bump forces a framework upgrade. Move to the versions the theme was built
against: Astro 5 -> 7 and @astrojs/starlight 0.33 -> 0.41.

- Migrate the markdown config off the Astro-7-deprecated
  markdown.rehypePlugins field to unified() from @astrojs/markdown-remark
  (now declared as a direct dependency), preserving the rehype-base-links
  pass. Clears the build's only deprecation warning.
- Update the branding test for v0.2.0's redesigned typography: headings are
  Space Grotesk (not Poppins) and the accent maps through --nbr-brand, a
  magenta-violet derived from --nbr-primary.

Build is clean and all 11 build tests pass on both the production subpath
and the PR-preview root base.
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

📄 Docs preview for docs/update-nebari-starlight-v0.2.0:
https://docs-update-nebari-starlight.nebari-software-pack-template.pages.dev

@dcmcand dcmcand merged commit 8d2ab75 into main Jul 7, 2026
4 checks passed
@dcmcand dcmcand deleted the docs/update-nebari-starlight-v0.2.0 branch July 7, 2026 08:24
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