Updated codebase#11
Merged
Merged
Conversation
IvanHargreaves
requested changes
May 18, 2026
Contributor
IvanHargreaves
left a comment
IvanHargreaves
left a comment
There was a problem hiding this comment.
The changes look good, and the README is very comprehensive.
However, I think we might need to consider reducing the amount of information in the README. Although it is excellent, it is so comprehensive that I suspect most people would give up reading it all, and the most essential information gets lost in the quantity.
Let's see if there are README sections we can drop, or reduce. The endpoint summaries seems excessive for example, in particular I'd look for anything which would give us a big maintenance burden of keeping README in step with code.
IvanHargreaves
approved these changes
May 19, 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
2 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.
No description provided.