Summary
Publish the existing MkDocs documentation as a real documentation site instead of only validating it in CI.
Why
FrameVitals already has mkdocs.yml, a docs/ tree, and a strict docs build workflow, but the public package metadata still points users back to the repository docs folder. A deployed docs site would make the project easier to discover, navigate, and trust.
Scope
- Add a GitHub Pages deployment path for the MkDocs site.
- Keep
mkdocs build --strict as a required validation step.
- Deploy only from the stable branch/release flow.
- Update package metadata and README documentation links to the deployed site.
- Document how maintainers preview docs locally.
Acceptance criteria
Priority: P0 — project maturity
Suggested labels: documentation, infrastructure
Summary
Publish the existing MkDocs documentation as a real documentation site instead of only validating it in CI.
Why
FrameVitals already has
mkdocs.yml, adocs/tree, and a strict docs build workflow, but the public package metadata still points users back to the repository docs folder. A deployed docs site would make the project easier to discover, navigate, and trust.Scope
mkdocs build --strictas a required validation step.Acceptance criteria
pyproject.tomluses the deployed site for theDocumentationURL.Priority: P0 — project maturity
Suggested labels: documentation, infrastructure