Repository navigation
docs: publish MkDocs site with GitHub Pages - #53
Merged
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.
Summary
Publish the reviewed MkDocs site to GitHub Pages after relevant changes reach
main.Why
The local site from 11A is useful and stable enough to provide a public reading experience. Deployment remains separate from pull request validation so branches cannot change the public site.
Changes
Documentationworkflow with separate build and deploy jobssite/as a Pages artifactgithub-pagesenvironmentQuality checksjobType of change
Checklist
Notes
GitHub Pages is already configured to use GitHub Actions as its source. The first production deployment will start only after this PR is merged to
main.Local verification:
uv run pre-commit run --all-filesuv run rumdl check .uv run mkdocs build --strictuv run pytest --cov=text_toolkit --cov-report=term-missinguv run mypyuv run ruff check .uv run ruff format --check .uv sync --locked --group devuv build --no-sources