Skip to content

docs: publish MkDocs documentation site - #121

Merged
codeforester merged 2 commits into
mainfrom
documentation/108-20260805-documentation-site
Aug 6, 2026
Merged

docs: publish MkDocs documentation site#121
codeforester merged 2 commits into
mainfrom
documentation/108-20260805-documentation-site

Conversation

@codeforester

Copy link
Copy Markdown
Contributor

Summary

  • Add a MkDocs Material site with navigation across the existing documentation set.
  • Add strict docs builds and repository link/example validation to CI.
  • Publish the reviewed site to GitHub Pages from main.
  • Add the canonical Documentation project URL to package metadata and replace README/security docs links with PyPI-safe rendered-site links.
  • Verify the Documentation URL in wheel metadata during artifact validation.

Issue

Closes #108

Validation

  • bash tests/validate.sh
  • python scripts/validate_docs.py
  • python -m mkdocs build --strict --site-dir /private/tmp/base-cli-docs-site
  • python -m pytest -q
  • ruff check lib/python scripts examples tests compatibility
  • Built and validated wheel/sdist metadata, including the Documentation project URL.

Deployment note

Repository Pages settings must use the GitHub Actions source and the github-pages environment must be approved for the first deployment.

@codeforester
codeforester merged commit c256d35 into main Aug 6, 2026
83 checks passed
@codeforester
codeforester deleted the documentation/108-20260805-documentation-site branch August 6, 2026 03:32
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.

Add rendered documentation site (ReadTheDocs or GitHub Pages)

1 participant