feat: add GitHub Pages with MkDocs documentation #8
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.
Summary
What's Included
MkDocs Configuration (
mkdocs.yml)Deploy Workflow (
.github/workflows/deploy-docs.yml)Documentation Structure
Each file contains section outlines with
!!! note "Section Summary"blocks indicating content to be written.After Merge
Once merged, the docs will be available at:
https://jeremyeder.github.io/reference/
The deploy workflow will run automatically on push to main.