Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrates project documentation from Sphinx-only output to an Astro Starlight site, with automated API/examples generation and updated publishing workflows.
What Changed
Added Starlight docs app (docs/astro.config.mjs, docs/package.json, docs/src/...) and migrated existing docs content into the new structure.
Added docs generation tooling:
docs/api_build.py to generate API reference pages from package modules.
docs/scripts/generate-examples-mdx.ts to generate example pages from examples/.
docs/scripts/generate-legacy-redirects.mjs + docs/legacy-routes.json for old URL compatibility.
Reworked docs build commands in pyproject.toml to run API generation + Starlight build.
Added reusable GitHub composite action for docs builds and updated CI/pages workflows.
Added workflow to publish docs to DevPortal.
Included internal migration plans/skills under .codex/algokit-prompts.
Notes
Legacy Sphinx page sources under docs/ were moved/replaced by Starlight content under docs/src/content/docs/.
CI now validates docs by building the Starlight site.