Add runnable guides and improve SEO checks - #4
Merged
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
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.
Pull Request
Summary
Improves the documentation’s usability, search visibility, AI discoverability, and version navigation.
Observable changes include:
Change type
Compatibility
No Python API, CLI, YAML/TOML, checkpoint, durable-run-data, provider, or tool protocol contracts are changed.
Verification
uv sync --locked --group devuv run python scripts/check_versions.pyuv run python -m pytest— 893 passed, 13 deselecteduv run python -m ruff check .uv run python -m ruff format --check src/uv run python -m pyright— 0 errors and 0 warningsuv run python -m mkdocs build --strictuv run python scripts/check_docs.py— 403 exports and 40 examples verifiedgit diff --checkDocumentation and release notes
site_docs/llms.txtreviewed and updated where needed[Unreleased]changelog entry addedReviewer notes
The documentation remains release-tag controlled:
mainvalidate documentation without replacing published versions.v*release tag deploys documentation.X.Ydocumentation version and thelatestalias.mike set-default --push latest.latestas the default alias./llms.txt, sitemap, robots metadata, canonical URLs, and version manifests were audited.This change does not authorize bypassing required checks, reviews, protected environments, or the release process.