ci(docs): add MkDocs site + GitHub Pages deploy#32
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.
Stands up a documentation site (MkDocs + Material) built from the existing
docs/tree and deploysit to GitHub Pages — part of the go-public work.
mkdocs.yml— Material theme, light/dark toggle, explicit nav over principles / architecture /reference / guides / decisions. Homepage reuses
docs/README.md(MkDocs mapsREADME.md→index),now with a short thesis lead.
.github/workflows/docs.yml— builds withmkdocs buildand deploys viaupload-pages-artifact+deploy-pages. Trigger: push tomain(paths-filtered todocs/**mkdocs.yml+ the workflow) plusworkflow_dispatch, so docs publish when a change lands — notgated on releases.
pyproject.toml— newdocsoptional-dependency group (mkdocs,mkdocs-material), version-cappedbelow the announced breaking
mkdocs 2.0/mkdocs-material 10..gitignore— ignoresite//_site/build output.Repo infra / docs-only — no
src/change.