Add basic documentation #198
Merged
Conversation
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
* Draft outline for mkdocs * Rename docs to documentation to avoid template conflict * Bump deps and version to 4.5.1
Pull Request Test Coverage Report for Build 18167516384Details
💛 - Coveralls |
TheByronHimes
approved these changes
Oct 2, 2025
Member
TheByronHimes
left a comment
TheByronHimes
left a comment
There was a problem hiding this comment.
Thanks for putting this together. There are many sections that have merely a heading without any text, but I don't think they all need a disclaimer about being a WIP because that's obvious and we're the only ones reading it at the moment.
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.
This PR adds the basic documentation and also merges all of the unfinished/unreviewed subsections (marked as such).
It also adds a mkdocs config and GitHub action to publish the documentation using GitHub pages.
The idea is to already publish what we have and then to successively improve the missing/unfinished sections. So no thorough review of this PR is needed. I have created issues for these sections already.
After this is merged, we should check that publishing the docs to GitHub pages works as expected and configure the repo accordingly.