monome / teletype

monome eurorack module
GNU General Public License v2.0
203 stars 84 forks source link

Reorganize docs sections and split cheatsheet in two #333

Closed Dewb closed 11 months ago

Dewb commented 11 months ago

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:

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,

tehn commented 11 months ago

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

dndrks commented 11 months ago

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