feat: add MkDocs documentation setup and deployment commands#26
Merged
feat: add MkDocs documentation setup and deployment commands#26
Conversation
- Introduced MkDocs configuration in `mkdocs.yml` for project documentation. - Added commands in `justfile` for serving, building, and deploying documentation. - Updated `README.md` with instructions for documentation setup and usage. - Created GitHub Actions workflow for automatic documentation deployment on push and tag events. - Enhanced documentation structure with new navigation and content organization.
- Added documentation and CI setup for GitHub Pages. - Bumped project version to `2.0.1` in `pyproject.toml`, `api.py`, and `README.md`. - Updated API version metadata and root welcome message to reflect the new version.
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
1 participant
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.
Note
Medium Risk
Mostly documentation/config changes, but it adds an automated deploy workflow with
contents: writepermissions that pushes togh-pages, so misconfiguration could affect Pages publishing.Overview
Adds a versioned documentation site powered by MkDocs Material +
mike, including newdocs/pages, Mermaid support, and navigation viamkdocs.yml.Introduces a GitHub Actions workflow (
docs_pages.yml) that builds docs strictly and publishes togh-pagesonmain(aliasesdev/latest) and onv*tags (release version +stable, settingstableas default).Updates developer workflows by adding
justcommands for serving/building/deploying docs, documents the publishing process inREADME.md, and bumps the package/API metadata from2.0.0to2.0.1(including the root welcome message andCHANGELOG).Written by Cursor Bugbot for commit 26094f3. This will update automatically on new commits. Configure here.