docs: reword the README intro and API pages - #72
Merged
Merged
Conversation
The README, the operations and channels pages, and the public header table now say where the types come from instead of how they are made.
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.
Rewords the user-facing docs to say where the library's types come from.
spec/, so their names match Kalshi's API docs." The contributing pointer now says "updating the specs".docs/operations.mdanddocs/channels.mdnow open with "Covers Kalshi's ... document". The change is in their templates intools/codegen/, followed bymake codegen, which changed only those two lines.include/README.mddrops the per-row build labels in the header table, and thekalshi::VERSIONbrief now says it comes fromproject(... VERSION).Left alone on purpose: the "Do not edit" banners at the top of the code generator's headers, the contributor docs that explain
make codegen, and past CHANGELOG entries. There's no CHANGELOG entry, since this is wording only.Testing
make lint(including the codegen check),make test(287 passed),./tools/test_consumers.sh,make docs, and markdownlint.