Skip to content

Conversation

@zastrowm
Copy link
Member

@zastrowm zastrowm commented Jan 30, 2026

Description

Note: This is targeting the workstream/cms-migration branch - the plan is to do incremental PRs to avoid a single PR with a bunch of code.


Step 1: Bootstrapping the new CMS with Starlight with minimal documentation/page rendering. Follow-ups will incrementally add functionality to the Starlight site.

You can preview these changes at via this preview - the medium term end-goal that I'm working towards is this preview - but this is N PRs ahead).

What works:

  • A weird looking starlight documentation site
  • Mermaid rendering
  • Python & TypeScript code snippets shown (but not in tabs)

What doesn't work:

  • The Sidebar
  • More advanced markdown (tabs, existing macro, etc.)
  • Links to other pages
  • Typecheck is failing; will address in a follow-up once the CMS is effectively more stable

Related Issues

#441

Type of Change

  • Other (please describe): CMS bootstrapping

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using mkdocs serve
  • Links in the documentation are valid and working

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Step 1: Get a barebones site working with Starlight, but pointing at our existing docs.

What works:

 - A weird looking starlight documentation site
 - Mermaid rendering
 - Python & TypeScript code snippets shown (but not in tabs)

Follow-ups will incrementally add functionality to the Starlight site
Copy link
Member

@Unshure Unshure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, you called out the failing typecheck so im sure its fine.

One other callout is preview testing in prs. I see that you posted a preview in the overview, but can we add a task to make this a part of a github workflow?

@zastrowm
Copy link
Member Author

LGTM, you called out the failing typecheck so im sure its fine.

One other callout is preview testing in prs. I see that you posted a preview in the overview, but can we add a task to make this a part of a github workflow?

Yeah, I'll create a follow-up task; I want to move it from the site preview to the docs, but we need a lot of pieces for that before it works.

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.

Migrate to new CMS running in development using default theme

2 participants