Skip to content

docs: publish MkDocs site with GitHub Pages - #53

Merged
michalmaj merged 1 commit into
mainfrom
docs/publish-mkdocs-site
Sep 30, 2026
Merged

michalmaj merged 1 commit into
mainfrom
docs/publish-mkdocs-site

Conversation

@michalmaj

Copy link
Copy Markdown
Owner

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

  • add a dedicated Documentation workflow with separate build and deploy jobs
  • build strictly from locked dependencies and upload site/ as a Pages artifact
  • restrict deployment permissions to the deploy job and use the github-pages environment
  • add the public site URL and a focused GitHub Pages chapter
  • document repository settings, triggers, permissions, logs, and troubleshooting
  • keep generated output out of Git and deployment out of the required Quality checks job

Type of change

  • Documentation
  • Project configuration
  • New feature
  • Tests
  • CI/CD
  • Refactoring
  • Bug fix

Checklist

  • The change is small and focused
  • The pull request title is clear
  • I updated documentation if needed
  • I added or updated tests if needed
  • I ran local checks if applicable

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-files
  • uv run rumdl check .
  • uv run mkdocs build --strict
  • uv run pytest --cov=text_toolkit --cov-report=term-missing
  • uv run mypy
  • uv run ruff check .
  • uv run ruff format --check .
  • uv sync --locked --group dev
  • uv build --no-sources

@michalmaj
michalmaj merged commit cd95dab into main Sep 30, 2026
1 check passed
@michalmaj
michalmaj deleted the docs/publish-mkdocs-site branch September 30, 2026 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant