Skip to content

feat: migrate from Starlight to Nimbus documentation framework - #15

Merged
diogoascarneiro merged 4 commits into
mainfrom
switch-docs-to-nimbus
Jul 6, 2026
Merged

feat: migrate from Starlight to Nimbus documentation framework#15
diogoascarneiro merged 4 commits into
mainfrom
switch-docs-to-nimbus

Conversation

@diogoascarneiro

@diogoascarneiro diogoascarneiro commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do?

Migrates the docs site from Starlight to Nimbus while keeping Astro 7, adds the Nimbus docs shell/components/configuration, and updates repo references from Starlight to Nimbus.

Also documents the Changesets requirement for package-affecting changes.

Closes N/A

Type of change

  • Bug fix
  • Feature
  • Refactor (no behavior change)
  • Documentation
  • Tests
  • CI / tooling
  • Chore

PolyStella invariants touched

  • None
  • Cache key formula
  • Translation batching / segment grouping
  • Apply-before-PUT cache write order
  • Local cache index isolation
  • Runtime bridge timing
  • URL-rewrite idempotence
  • Provider permanent vs retriable errors
  • R2 key / local path separator handling

Checklist

  • I have read CONTRIBUTING.md
  • I have added or updated tests, or this change does not need tests
  • I have added a changeset, or this change does not affect the published package
  • I have updated docs, or this change does not affect public behavior
  • pnpm test passes, or I have explained why it was not run
  • pnpm exec tsc --noEmit passes, or I have explained why it was not run
  • Docs checks/builds pass if docs or public APIs changed

AI-generated code disclosure

  • This PR includes AI-generated code - model/tool: OpenCode / gpt-5.5

Screenshots / logs / test output

Passed locally:

  • pnpm --filter polystella-docs build
  • pnpm exec prettier --check docs
  • pnpm --filter polystella-docs exec nimbus-docs lint
  • pnpm --filter polystella-docs check-exports
  • pnpm --filter polystella-docs check-examples
  • pnpm test
  • pnpm exec tsc --noEmit

Replace @astrojs/starlight with nimbus-docs as the documentation site framework. Add Tailwind CSS v4, Pagefind search, custom fonts (Inter, JetBrains Mono), and astro-icon/astro-og-canvas integrations. Convert splash page hero from Starlight components to custom Nimbus layout with Tailwind styling. Update content config to use Nimbus collections with custom schema fields. Add TypeScript path aliases and update all references from
@github-actions github-actions Bot added review/needs-review No maintainer review yet area/docs Documentation size/XL 500+ changed lines labels Jul 6, 2026
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Scope check

This PR changes 6,828 lines across 106 files. PolyStella is maintained by a small team, so smaller focused PRs are more likely to be reviewed.

If this scope is intentional, no action is required.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 6, 2026

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Failed ❌

View logs ↗
8011fa2 2026-07-06T11:01:20.515Z View logs ↗
  • Build: Cancelled 🚫

View logs ↗
5b44e27 2026-07-06T10:49:40.837Z View logs ↗
  • Build: Failed ❌

View logs ↗
a8011d9 2026-07-06T10:32:46.730Z View logs ↗
  • Build: Failed ❌

View logs ↗
8120b2f 2026-07-06T10:14:00.106Z View logs ↗
  • Build: Failed ❌

View logs ↗
ab588a2 2026-07-06T10:05:30.697Z View logs ↗

Add `pnpm changeset` command to scripts table and expand "Always" section with guidance on when to create Changesets entries vs empty changesets for non-release changes (docs-site-only, CI-only maintenance).
@github-actions github-actions Bot added the area/github GitHub workflows and repo management label Jul 6, 2026
Replace remaining "Starlight" references with "Nimbus docs" in workflow job name, contributor guide, and README to reflect the documentation framework migration.
@diogoascarneiro
diogoascarneiro force-pushed the switch-docs-to-nimbus branch from a8011d9 to 5b44e27 Compare July 6, 2026 10:32
Add `aiGenerated: true` frontmatter field to all documentation pages drafted by AI agents. Update content schema to accept the boolean flag, add it to config reference generation script, and wire it into PageActions component to display "AI-generated · awaiting review" badge with sparkle icon when present.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 6, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
polystella-docs 8011fa2 Commit Preview URL

Branch Preview URL
Jul 06 2026, 11:01 AM

@pkg-pr-new

pkg-pr-new Bot commented Jul 6, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@cloudflare/polystella@8011fa2

commit: 8011fa2

@diogoascarneiro
diogoascarneiro merged commit 48dba52 into main Jul 6, 2026
16 checks passed
@diogoascarneiro
diogoascarneiro deleted the switch-docs-to-nimbus branch July 6, 2026 11:02
@github-actions github-actions Bot mentioned this pull request Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation area/github GitHub workflows and repo management review/needs-review No maintainer review yet size/XL 500+ changed lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant