Open
Conversation
Added PyInstaller hidden imports for: - algokit_abi, algokit_indexer_client, algokit_kmd_client (standalone packages) - algokit_utils.algo25, algokit_utils.transact, algokit_utils.common, algokit_utils.clients (proxy modules that re-export from standalone packages) This fixes 'No module named algokit_utils.algo25' error in portability tests.
The portability tests were inadvertently using the venv-installed algokit instead of the PyInstaller binary because 'poetry run' prepends .venv/bin to PATH, causing 'algokit' to resolve to the venv version. - Add _get_algokit_binary() to explicitly find the PyInstaller binary in dist/ - Support PYINSTALLER_BINARY_PATH env var for explicit binary path - Filter out .venv/bin (or .venv/Scripts on Windows) from PATH fallback - Add Windows compatibility with os.pathsep and .exe extension - Remove unused command_str_to_list function
Bootstrap Astro Starlight using the official template. Adds package.json, tsconfig.json, content.config.ts, and .gitignore for the docs site. Includes remark-github-alerts for callout box support and the AlgoKit favicon.
Configure Starlight for algorandfoundation.github.io/algokit-cli/ with full sidebar structure covering tutorials, features, concepts, architecture decisions, and auto-generated CLI reference. Adds cli-reference.css for sphinx-click output styling.
Move all 44 docs pages into docs/src/content/docs/ with Starlight frontmatter, correct absolute internal links, and updated image paths. Copy all image assets to docs/public/images/. Build produces 46 pages cleanly.
lempira
had a problem deploying
to
github-pages
GitHub Actions
Failure
lempira
had a problem deploying
to
github-pages
GitHub Actions
Failure
lempira
force-pushed
the
docs/starlight-migration
branch
from
936451a to
26fb7dd
Compare
aorumbayev
force-pushed
the
decoupling
branch
2 times, most recently
from
9d0faf4 to
c0267c3
Compare
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
3 participants
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.
This PR migrates the algokit-cli documentation from 44 markdown files served directly from GitHub to an Astro Starlight site deployed to GitHub Pages at algorandfoundation.github.io/algokit-cli/, bringing it in line with algokit-utils-py and algokit-subscriber-py.
The migration covers the full stack: Starlight scaffold with sidebar navigation, a splash home page, content migration of all hand-written docs (features, tutorials, concepts, ADRs), and a cli_build.py script that runs sphinx-click to auto-generate the CLI reference page. CI is updated with a check-docs workflow that validates the build on every PR, and a deploy-docs job in cd.yaml that publishes to GitHub Pages on merge to main.
The sphinx/sphinx-click setup is preserved unchanged — only the output destination and post-processing change. Sphinx deps are moved from the dev group to a dedicated docs group (poetry install --with docs) so they don't bloat the default dev install.
Doc Preview