monome / docs Goto Github PK

https://llllllll.co/t/norns-fates-data-dir-is-nil/30926

content doesn't match https://github.com/monome/norns/blob/master/lua/core/config.lua

http://monome.org/docs/app/ -> http://monome.org/docs/app/package/ is 404'ing, even though the doc is live: https://github.com/monome/docs/blob/gh-pages/app/package.md

wasn't sure how to get this cleaned up on my own :\

https://monome.org/docs/crow/scripting/reference

I seem to have been able to access this a couple of days ago from the crow/scripting page. Might this be related to the migration to github pages?

Fresh install, trying to run studies5.lua, documented here just shows a black screen. I might be able to fix this issue soon enough.

docs are about to be migrated to gh-pages and the css/layout (jekyll) will be fully exposed

quick list of improvements:

• link visibility
• code blocks could use definition, perhaps a thin outline (like discourse/slack)
• table formatting is totally messed up

current doc for Cycles is missing descriptions for additional config pages (K1 press while holding K2):

• Range (to attenuate the output level of Cycles)
• Pulse Multiplier (change how many pulses are output from a full rotation)

did we lose these when breaking up the apps into individual pages?

Sam Doshi has a great blog post about Euclidean Rhythms that would benefit the reader of the Teletype user manual:

http://samdoshi.com/post/2016/03/teletype-euclidean/

from monome/ansible#30

track muting: hold the loop mod button and press a track button to toggle its mute state

clock-relative durations: when the max duration is set, pulse-width of the gate is 100% based on current clock. works as a tied note.

teletype track clocking: set a track to be clocked by teletype in the upper left of the pattern screen. when activated, track will only advance when KR.CLK x is called specifying the track (0 will clock all activated tracks).

Is this still true, now that Crow has official(?) support for audio-rate oscillation?

(issue credit @postsolarpunk)

Please change the reference from ~ to Tab and NumLock to get to the Tracker

Would there be any value in writing up a document on writing apps using libmonome directly (without the OSC layer)? This is how I personally have been using my grid/arc on osx/linux for the past few years. I'd be happy to contribute this if there is interest.

Looks like I checked in a version that pointed to the wrong image file this line


should be


Should I do another pull request?

From https://github.com/monome/docs/blob/gh-pages/serialosc/osc.md#sys:

/sys/rotation i

rotate the monome by degrees, where degrees is one of 0, 90, 180, 270. this replaces /cable

It's unclear whether this includes the arc, but according to monome/serialosc#55 (comment) arc is not supported.

needs completion, see monome/norns#717

https://monome.org/docs/norns/script-reference/

sources here https://github.com/monome/docs/blob/master/docs/norns/script-reference.md

from @zop on lines:

In the meta-pattern section, there is this paragraph:

The meta-sequencer is clocked by the divider in row 2 and controls how long the current pattern will play before moving on to the next pattern. Row 2 itself is clocked by the current tempo (either internal or external), however if you hold the Duration modifier you can subdivide the current tempo driving the row 2 clock divider, for extremely long step times.

The “Duration” modifier I believe should be referred to as the “Time” modifier, as that is the term used to refer to the clock division modifier accessed by that key throughout the rest of the documentation.

The docs make reference to a default time, but don't say what it is.

The input.lua file seems to suggest it's 0.1, but this isn't stated in the script reference and probably should be. I can't find where those docs are generated from, or I'd file a pull request myself.

Relatedly, there's a mismatch between the Crow Studies page and the script it refers to around this command. It looks like the latter has been updated but the former hasn't. I'll see if I can file a pull request to fix that when I get a moment.

Currently for product pages, the Vimeo embed at the top is not responsive, so things horizontally scroll on mobile. See the root teletype doc page for example.

On the Teletype variables are listed as a mix of A / B and for some operators X.

But in the user manual it seems exclusively X and sometimes Y too.

For example; TT Help has P.WRAP A while the user manual lists this op as P.WRAP X

Why would this not be consistent across presentations?

i propose installing the all-contributors bot
https://allcontributors.org/
i really like what we have done at the p5.js repo
https://github.com/processing/p5.js
where we celebrate all contributions,
i think it makes everyone in the community happier
:)

edit: I can't take this on, as it requires validation and testing through Windows

https://llllllll.co/t/crow-help-general-connectivity-device-qs-ecosystem/25866/113

https://docs.google.com/document/d/11Bnly-JOBh4_mWSyIGmEIpE_YO-6VH179KSHEWTZr2M/edit

supplemental documentation from oootini:

Crow becomes unresponsive and won’t respond even after power cycling your case

Sometimes a script can crash crow and cause the device to report a “warning: unknown usb device” error. This error persists even after the case is powered down.

To resolve this error, reflash the device firmware as described in Firmware Update and then run erase_userscript.sh. This removes the broken script that causes crow to crash on startup.

For windows users, run the following:

dfu-util -a 0 -s 0x08020000 -R -D crow.bin -d ,0483:df11
then
dfu-util -a 0 -s 0x08010000 -R -D blank.bin -d ,0483:df11

Once you erase the broken script, crow should be back to the default state with the first script loaded.

hey there! wasn't sure how to submit a PR for this as it's an image, but on line 26 of https://github.com/monome/docs/blob/master/docs/grid-studies/nodejs/images/grid-studies-nodejs-2.png there appears to be a [ to the left of s, when you want a {. only noticed because i wasn't sure why i was getting key received: 0, 0, $[s} 😛

cheers!

The Ansible documentation is getting really long.

This thread on lines is in part about a perceived issue that came down to

• a change in default behaviour after a firmware update
• ...that they couldn't find an explanation of how to alter in the documentation
• ...despite it actually being documented.

Ansible now has... five apps, MIDI support, Teletype docs, USB disk mode docs, and further notes. This is a lot for one page, and the monome site's design means that headers aren't super-varied in their styling (despite header levels being well-used in the docs).

I propose that we break up Ansible into an 'index' page (with brief descriptions of the apps, and some global notes) as well as individual documentation pages for apps. This is also a good opportunity to review the docs properly, for inaccuracies, duplication, and also for consistency in terminology.

I'm happy to take the lead on this, but want to raise it with the community.

The shortcut for Help is listed at Alt + ? in the user manual when it should read Shift + Alt + ?

(section: "dolphin and seagull" example)

according to tts5.md, line 218, script two is supposed to "Ramp down CV 4". but that script in tts5.png uses CV D, so it will never get turned off. CV 4 level always remains high. either the text in tts5.md needs to be changed to CV D, or the image needs to be updated to CV 4.

The "advanced.md" in the Teletype/docs directory has a drawing explaining the PRE / POST terminology that is not currently in the user manual. I find this helpful and think others would too.

The following information is missing from the user manual:

Scenes that are saved from the TT will be stored as

tt00s.txt
on your flash drive. The numbers will be the scene number and note the “s”.
To load something from the flash drive you just need to rename the file, and leave off the “s”.

To load the mlr.txt file to scene number 10 you rename the file to

tt10.txt
and place it on your flash drive.

Can we add a license so it's clear how the content can be re-used? Given it's all docs, I guess creative commons would make the most sense.

A left hand navigation would be beneficial for users. it's expected for most docs sites IMO.

https://github.com/monome/docs/blob/a00b371c45c7f3edf7826a006e5efae4cb8d8a47/docs/modular/teletype/index.md#usb-flash-drive-scene-readwrite

starting an issue to collect feedback from folks on discord re: crow 4.0 docs!

• hotswap
• seeded random
• sequins v2
• timeline
• updated reference

Pattern sections in musical example code are not formatting as intended after commit.

Would have opened a PR with the fix myself, but I couldn't seem to find the source material that these pages are building from as I see the docs are automatically built using LDoc

But for the Arc:segment (ring, from, to, level) description, the word specific is spelled incorrectly: on a sepcific LED ring.

The typo exists in the following lines as seen rendered out here https://monome.org/docs/norns/api/modules/arc.html#Arc:segment:

• https://github.com/monome/docs/blob/gh-pages/norns/api/classes/arc.html#L331
• https://github.com/monome/docs/blob/gh-pages/norns/api/modules/arc.html#L129

tracking issue for doc updates corresponding w/ norns 2.0

bits to review:

• studies
  • study 1
  • study 2
  • study 3
  • study 4
  • study 5
• update instructions
• legend
• faq
• roadmap

ansible/index.md, line 347:

col 4: RESET
    by default, self is toggled on. toggle on other rows for this row to reset those rows
    way to make one-shots

i'm not sure what this text meant to say around the linebreak of "way to make one-shots," else i would have filed an actual pull request with suggested text. it looks like a section got deleted mid-sentence. maybe something like "this is a way to make one-shots," with a short phrase explaining what those are in this context?

Perhaps an unimportant detail but surprised me for a moment when I tried to change a URL bar from the Ansible docs to the Crow docs. I realize this would probably break some URLs elsewhere, maybe /docs/crow could redirect to /docs/modular/crow or vice versa. Seems nice for consistency, especially if there were a desire to have a /docs/modular page giving a high level overview of all the modular stuff.

While coders may already be familiar with L as the alias for Loop, it is not explicitly defined in the user manual. See page 31

The same regarding W for While.

Just got my DIY Norns (assembled quickly and works flawlessly by the way, fantastic kit!) as I started going through the studies. I noticed a missing space on line 16 of the many tomorrow code sample from https://monome.org/docs/norns/study-1/:

octave =1

Wanted to fix it quickly but requiring a pull request approval etc etc and presumably a re-deployment of the website for a 1 space fix is a lot of work (and it's just aesthetics, the code is still functional). Would Monome be up for using embedded Github gists (<script src="https://gist.github.com/mwilliams/79fa4fe7835755d291c739582fc15ca8.js"></script> for example which would render out on the Studies page a very nice code sample) for all the code samples? People could fork them if they wanted (the more complex ones), you get syntax color highlighting for free, along with line numbers etc etc. Seems like there's a lot of upside. And if you need to fix any code examples, you just need to update the Gist and not the entire website.

I'd be up for potentially porting over all of the Norns code samples as I go through its Studies, is this an effort that's worthwhile and would be welcomed?

A site specific search would be a very useful addition to the monome docs.