Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize docs sections and split cheatsheet in two #333

Merged
merged 12 commits into from Dec 19, 2023

Conversation

Dewb
Copy link
Contributor

@Dewb Dewb commented Dec 18, 2023

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:

  • Pitch, Rhythm, and Randomness sections broken out of Maths
  • Some Variables ops move into Randomness
  • Seed merged into Randomness
  • Some Hardware ops move into Calibration
  • Perhaps most controversially, V and VV move from Maths to Hardware

Provide 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,

  • updated CHANGELOG.md and whats_new.md
  • updated the documentation
  • (n/a) updated help_mode.c (if applicable)

@Dewb Dewb changed the title Feat/v5 docs split Reorganize docs sections and split cheatsheet in two Dec 18, 2023
@tehn tehn merged commit 00f5fd2 into monome:main Dec 19, 2023
5 checks passed
@tehn
Copy link
Member

tehn commented Dec 19, 2023

looks great! @dndrks can you get these uploaded to the main docs page also?

@dndrks
Copy link
Member

dndrks commented Dec 19, 2023

@Dewb !! amazing amazing amazing!!!
thank you so much.
merged into main docs: https://monome.org/docs/teletype/#learning-teletype

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants