Ansible Earthsea Documentation #97
Conversation
mentioning clocking.
language as per scanner_darkly's comments.
updating the anisble docs to include documentation for: Trigger ratcheting Alternate note Glide Included with this are 2 new images and 2 new illustrator files (source for the images)
changed some wording to make ratcheting more clear. Updated the names of the png's to remove the increments added by exporting from illustrator. Updated index to reflect new png names. Updated png's to make the per track nature of the parameter extensions more clear
Updating the docs to reflect the changes to ansible firmware update 1.5 https://llllllll.co/t/ansible-1-5-0/7475. And only a year later.
Including illustrator files and a png image.
testing out video link
Changing the image position around and trying to clarify wording.
as discussed.
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
updating the anisble docs to include documentation for: Trigger ratcheting Alternate note Glide Included with this are 2 new images and 2 new illustrator files (source for the images)
changed some wording to make ratcheting more clear. Updated the names of the png's to remove the increments added by exporting from illustrator. Updated index to reflect new png names. Updated png's to make the per track nature of the parameter extensions more clear
Updating the docs to reflect the changes to ansible firmware update 1.5 https://llllllll.co/t/ansible-1-5-0/7475. And only a year later.
testing out video link
Changing the image position around and trying to clarify wording.
as discussed.
Needs comparison with running code, and also needs illustrations updating.
|
i'll fix the merge now! |
|
eep - I am not sure this actually describes the code that is currently available in master? I mean, it will do shortly, but I was going to wait to confirm the latest Ansible was released? just me thinking about belt/braces is all. |
|
looks good - thanks for doing this! |
|
just merged ansible master, if we need to double-check the docs. |
|
oh, cool - and now @scanner-darkly has seen it too. do we need to push a deploy to the monome site in order to update the ansible page? |
|
yes i'm happy to deploy it now, though we haven't yet published the official release for ansible... people still have to build it. @scanner-darkly @csboling any outstanding issues prior to making a release? i might need a hand checking the changelog, much has happened! |
|
@tehn I still need to PR new Teletype ops ( |
|
@tehn no issues i'm aware of |
This PR includes:
note that
ansible/index.mdfalls into the category of 'large updates' and as such you'll need to unfurl it in the PR.I'm also aware that this PR can't be auto-merged. I don't think any information has been lost - rebasing markdown is painful, to say the least. Let me know what you all think; I think @scanner-darkly is an important reviewer on this.