Reorganize docs sections and split cheatsheet in two #333
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.
What does this PR do?
Reorganizes op documentation. Splits some categories that have grown large, adds short descriptions to some ops that did not have any. Moves some ops between sections for better learnability. Reorders the sections so they fit on the cheatsheets better with fewer sections split across page breaks.
Splits the cheatsheet into separate "core" and "i2c" PDFs. The core PDF is 4 pages, the i2c PDF is 7 pages.
Example output:
Major category changes:
V
andVV
move from Maths to HardwareProvide links to any related discussion on lines.
This came out of conversations in the teletype study group Discord.
How should this be manually tested?
See example docs output above.
Any background context you want to provide?
n/a
If the related Github issues aren't referenced in your commits, please link to them here.
I have,
CHANGELOG.md
andwhats_new.md
help_mode.c
(if applicable)