add teletype 1.2 info #1
Merged
Conversation
|
looks great, thank you! |
infovore
referenced
this pull request
in infovore/monome-docs
Apr 18, 2018
So: a few changes I've made, which are up for discussion:
* house style seems to be passive voice, so I've removed 'you' where
appropriate
* house style also calls keys on the grid 'keys' or, wherever possible,
just refers to them by the function they are performing ("press
'octave'; the octave key will light"). So I've removed 'button' and made
appropriate changes
* for entirely personal reasons I found 'extended parameters' more
appropriate than 'parameter extensions'
* I've moved some things around. More specifically: the "parameter
extensions" documentation mentions loop/probability/division _before_
we've explained it in the main documentation! So: key, 'basic'
parameters are explained; we mention that there are also extended
parameters, see later; then modifiers are explained; then the extended
parameters section
* replaced h5s with h4s, h5 renders tiny in the default stylesheet
* sub-page, not sub page
* Took a pass at explaining each mode in a single sentence. Also removed
some of the narrative style (referencing previous paras) because
a use-case for documentation is jumping straight to a para. So there's
a bit more repetition, but I think that's OK for technical writing.
* added TODOs for the Teletype commands
tehn
pushed a commit
that referenced
this pull request
Jun 13, 2019
So: a few changes I've made, which are up for discussion:
* house style seems to be passive voice, so I've removed 'you' where
appropriate
* house style also calls keys on the grid 'keys' or, wherever possible,
just refers to them by the function they are performing ("press
'octave'; the octave key will light"). So I've removed 'button' and made
appropriate changes
* for entirely personal reasons I found 'extended parameters' more
appropriate than 'parameter extensions'
* I've moved some things around. More specifically: the "parameter
extensions" documentation mentions loop/probability/division _before_
we've explained it in the main documentation! So: key, 'basic'
parameters are explained; we mention that there are also extended
parameters, see later; then modifiers are explained; then the extended
parameters section
* replaced h5s with h4s, h5 renders tiny in the default stylesheet
* sub-page, not sub page
* Took a pass at explaining each mode in a single sentence. Also removed
some of the narrative style (referencing previous paras) because
a use-case for documentation is jumping straight to a para. So there's
a bit more repetition, but I think that's OK for technical writing.
* added TODOs for the Teletype commands
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.
I think I've got the internal Ansible link correct, but I've got no way to check.
I didn't do the
JFstuff as I have no idea what any of it does.(Also, please excuse the blatant self promotion for the Euclidean rhythm stuff, it was too much effort to summarise the information)