Repository navigation
Add full docs site and enhance CLI/docstrings - #50
Merged
Merged
Conversation
- Replaced Python 3.12 with 3.11 in CI to ensure compatibility. - Added `make test-docs` and CI step to validate Markdown examples using pytest-markdown-docs. - Introduced `.github/workflows/docs.yml` for deploying documentation via MkDocs. - Added `mkdocs.yml` config with Material theme, plugins, and nav structure. - Added new docs pages: `concepts.md`, `explain.md`, `quickstart.md`, and API reference stubs. - Linked Markdown docs to `README.md` and `CONTRIBUTING.md` via includes. - Added docstring annotations to `TypeID` class and methods for clarity and API documentation. - Enhanced CLI commands (`new`, `encode`, `decode`, `explain`) with usage/help strings. - Updated examples and README for better testability and structured usage.
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.
make test-docsand CI step to validate Markdown examples using pytest-markdown-docs..github/workflows/docs.ymlfor deploying documentation via MkDocs.mkdocs.ymlconfig with Material theme, plugins, and nav structure.concepts.md,explain.md,quickstart.md, and API reference stubs.README.mdandCONTRIBUTING.mdvia includes.TypeIDclass and methods for clarity and API documentation.new,encode,decode,explain) with usage/help strings.