Skip to content

chore(deps): migrate docs to Astro 6 + Starlight 0.39 - #105

Merged
rz1989s merged 1 commit into
mainfrom
chore/docs-astro-6
Jun 4, 2026
Merged

chore(deps): migrate docs to Astro 6 + Starlight 0.39#105
rz1989s merged 1 commit into
mainfrom
chore/docs-astro-6

Conversation

@rz1989s

@rz1989s rz1989s commented Jun 4, 2026

Copy link
Copy Markdown
Member

Summary

Migrates docs-sip to Astro 6 + @astrojs/starlight 0.39 (Starlight 0.39 requires Astro 6). Supersedes #100 — will close it once green.

The typedoc / @sip-protocol/sdk bumps (#104) are an independent concern (typedoc generates the API-reference markdown; unrelated to the framework) and are intentionally not in this PR.

Dependencies

Package From To
astro ^5.16.11 ^6.4.3 → 6.4.4
@astrojs/starlight ^0.37.3 ^0.39.3

(Transitively: @astrojs/mdx 4→5, markdown-remark 6→7, compiler 2→4, prism 3→4 — all peer-consistent with Astro 6.) Lockfile regenerated from scratch (the incremental update hit a stale-tree ERESOLVE).

Code migration (breaking changes)

  • astro.config.mjs — Starlight 0.39 restructured autogenerated sidebar groups: autogenerate must nest under items, and subgroups no longer inherit the parent's collapsed state. The reference/ dir has subdirectories (classes, functions, interfaces, …), so autogenerate.collapsed: true is set to preserve the collapsed UX.
  • src/components/SiteTitle.astro — dropped the unused import type { Props } from the deprecated @astrojs/starlight/props path.
  • Head.astro — unchanged; its <Default> wrap + astro:page-load mermaid re-render still valid under Astro 6.

Not affected: content collections already use docsLoader()/docsSchema(); the og:image head entry already has content inside attrs; no ViewTransitions/Astro.glob/raw-zod usage.

Environment

Astro 6 needs Node ≥22.12 — added engines.node and bumped the three workflows (docs-validate, scheduled-api-sync, deploy) node 20 → 22.

Verification (local)

  • npm install clean (fresh tree, no peer conflicts)
  • npm run build — typedoc docs:api + astro build green: 1277 pages, Pagefind search index, sitemap
  • ✅ API Reference sidebar renders (autogenerate fix), custom SiteTitle + Head compile

Please verify on the Vercel preview

  • Preview builds (confirms Vercel Node ≥22.12)
  • Sidebar — API Reference group + subgroups render & collapse correctly
  • Mermaid diagrams render (client-side), light/dark toggle
  • SDK version badge in the site title, Pagefind search

@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sip-docs Ready Ready Preview, Comment Jun 4, 2026 4:52am

Supersedes #100 (astro 5->6.4.4, @astrojs/starlight 0.37->0.39.3). Starlight
0.39 requires Astro 6, and both carry breaking changes needing code updates.

- astro.config: Starlight 0.39 restructured autogenerated sidebar groups —
  `autogenerate` must nest under `items`, and subgroups no longer inherit the
  parent's collapsed state, so set autogenerate.collapsed explicitly.
- SiteTitle override: drop the unused `import type { Props }` from the
  deprecated `@astrojs/starlight/props` path.
- Node: Astro 6 requires >=22.12 — add engines.node and bump the three
  workflows (docs-validate, scheduled-api-sync, deploy) 20 -> 22.

The typedoc/SDK bumps (#104) are independent and intentionally left out here.
Content collections already use docsLoader/docsSchema (no migration needed).

Verified: npm run build (typedoc docs:api + astro build) green — 1277 pages,
Pagefind search index, sitemap.
@rz1989s
rz1989s force-pushed the chore/docs-astro-6 branch from 3026268 to 47c934c Compare June 4, 2026 04:51
@rz1989s
rz1989s merged commit 570d363 into main Jun 4, 2026
3 checks passed
@rz1989s
rz1989s deleted the chore/docs-astro-6 branch June 4, 2026 04:59
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