Skip to content

docs: add MkDocs documentation site and expand README#88

Merged
vc1492a merged 2 commits into
mainfrom
dev
Jun 13, 2026
Merged

docs: add MkDocs documentation site and expand README#88
vc1492a merged 2 commits into
mainfrom
dev

Conversation

@vc1492a

@vc1492a vc1492a commented Jun 13, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a full MkDocs documentation site (Material theme, monochrome) with pages for: algorithm explanation, getting started, user guide, examples, API reference, contributing, and changelog
  • Expands the README with two new sections: "How It Works" (LoOP algorithm pipeline) and "Exceptions and Error Handling" (custom exception hierarchy)
  • Adds a documentation badge and links to the hosted docs in the README
  • Updates commit message guidelines to remove release-please references
  • Adds a GitHub Actions workflow (.github/workflows/docs.yml) that deploys docs to GitHub Pages on push to main

Before merging

  • Preview docs locally with mkdocs serve
  • Set GitHub Pages source to gh-pages / / (root) in repo settings
  • Review all docs pages for accuracy

Closes #34

Made with Cursor

vc1492a and others added 2 commits June 13, 2026 16:27
- Add "How It Works" section to README explaining the LoOP algorithm pipeline
- Add "Exceptions and Error Handling" section to README documenting custom exceptions
- Add documentation badge and links to hosted docs in README
- Update commit message guidelines to remove release-please references
- Set up MkDocs with Material theme (monochrome) and GitHub Pages deployment
- Create docs site with pages: index, how-it-works, getting-started, user-guide,
  examples, API reference, contributing, and changelog
- Add GitHub Actions workflow for automatic docs deployment on push to main

Closes #34

Co-authored-by: Cursor <cursoragent@cursor.com>
Update the CI test matrix, README, and docs to include Python 3.14.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vc1492a vc1492a merged commit 098983b into main Jun 13, 2026
19 checks passed
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.

Library documentation

1 participant