Add Documentation - #305
Merged
Merged
Conversation
samaloney
approved these changes
Aug 11, 2026
samaloney
left a comment
Member
There was a problem hiding this comment.
Nice looks good based on brief read over. As you say I'm sure when it is used some potential improvements may surface.
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.
This isn't perfect by a long shot, but it's better than nothing and also a good place to start for future improvements.
AI Assistance Disclosure
AI tools were used for:
I mainly had the AI figure out all the things I should cover, I wrote most of the words.