Conversation
- 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>
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.
Summary
.github/workflows/docs.yml) that deploys docs to GitHub Pages on push tomainBefore merging
mkdocs servegh-pages// (root)in repo settingsCloses #34
Made with Cursor