Merge 123828ec9c96702a5f85bae829044d1d5874ba79 into 4f1c777ffd068eaf309dcac327b39206ec9e9306
4d0fb5e6
pull/87/merge
131/21,386 ++ 15,967 --
[skip ci] Automatically generated by python-semantic-release
* ci: add DevPortal publishing pattern - Add static MDX generation from example source files - Migrate docs from npm to pnpm - Extract sidebar to sidebar.config.json - Add publish-devportal-docs workflow - Simplify content.config.ts (remove examples collection) - Delete dynamic example pages * fix: docs build was failing with incorrect --group docs * fix(ci): broken publish docs action * ci: align docs tooling with utils-py PR review feedback - Use `pnpm --dir docs` instead of `cd docs &&` in poe tasks - Use `package_json_file` for pnpm version auto-detection in CI - Bump actions/checkout and actions/setup-node to v6 in devportal workflow - Add `@types/node` devDep and scope tsconfig types for IDE fixes * chore: removed unused import
- Use `pnpm --dir docs` instead of `cd docs &&` in poe tasks - Use `package_json_file` for pnpm version auto-detection in CI - Bump actions/checkout and actions/setup-node to v6 in devportal workflow - Add `@types/node` devDep and scope tsconfig types for IDE fixes
- Add static MDX generation from example source files - Migrate docs from npm to pnpm - Extract sidebar to sidebar.config.json - Add publish-devportal-docs workflow - Simplify content.config.ts (remove examples collection) - Delete dynamic example pages
[skip ci] Automatically generated by python-semantic-release
Integrates the 15 runnable subscriber examples into the Starlight documentation site <img width="1436" height="917" alt="image" src="https://github.com/user-attachments/assets/d4b80da5-5239-4119-8ab8-93de7e952f14" />
[skip ci] Automatically generated by python-semantic-release
This PR replaces the single-page Sphinx/Markdown documentation with a full Astro Starlight site, bringing algokit-subscriber-py in line with the TypeScript library's documentation approach. The old docs/ directory (Sphinx HTML config, flat markdown pages) is replaced with an Astro project aligning with algokit docs. Hand-written content is reorganised into Getting Started, Guides, Concepts, and API Reference sections with proper sidebar navigation and a splash homepage. API reference docs continue to be generated from Python docstrings via Sphinx + sphinx-autoapi, but are now post-processed by docs/api_build.py — a Python script that injects Starlight frontmatter, flattens the autoapi directory structure, strips duplicate H1 headings, and rewrites Sphinx-generated anchors to match Starlight's rehype-slug format. CI gains a reusable publish-docs composite action (Python + Node build), a check-docs.yaml workflow that validates docstrings and builds the site on every PR, and a gh-pages.yaml workflow for production deployment to GitHub Pages.