Add content to docs#5
Merged
Merged
Conversation
hoyer-a
approved these changes
Jan 19, 2026
hoyer-a
left a comment
hoyer-a
left a comment
Collaborator
There was a problem hiding this comment.
Found a typo, otherwise looking good for now.
robaru
approved these changes
Jan 23, 2026
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
3 participants
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.
Add classes and modules to docs
Fix wrong information in CONTRIBUTING because its rendered as part of the docs
Detailed documentation is intended to be added at a later point.
Requires add imports for classes and modules #4
because we don't already have CI, the easiest way to check this out is to locally build the docs
cd docs make htmlAnd then open /docs/_build/html/index.html
@hoyer-a tagging you to make sure you don't also do the work.