progress report
norns docs rewritten
- about two months ago, ahead of the new no-solder shield, we rewrote all of the norns docs to include shield at the start
- we also revised the overall docs journey, hopefully making it easier for an uninitiated user to pick a topic and move linearly through toward better understanding that facet of the ecosystem:
- we took the opportunity to clarify UI + hardware interactions with reference images:
- we embraced samba as the primary method for file transfers between norns and another computer
-
sftp docs are still around, but it’s not a common usecase and so they’re hidden from the main learning journey
reference projects: help wanted!
inspired by experiences navigating references for our own personal learning projects (processing, p5.js, and [as always] supercollider), we’ve begun work on two different projects which we’d love help from anyone looking to kill some time:
~/~/~/~/~/~/~/~/~/~/~/~/~/~/
new: maiden REPL help
~/~/~/~/~/~/~/~/~/~/~/~/~/~/
with 210114, it’s possible to receive code hints directly in maiden by executing help() commands in the REPL:
example: help(grid)
--------------------------------------------------------------------------------
grid.connect( port ) create a grid table using device [port]
default [port] 1 if unspecified
(returns) grid table
.key( x, y, z ) function called with incoming grid key event
this should be redefined by the script
.led( x, y, level ) set LED at [x,y] to [level]
[level] range is 0..15
.all( level ) set all grid LED to [level]
[level] range is 0..15
.refresh() update the grid LED state
--------------------------------------------------------------------------------
-- example
lx,ly,lz = 0,0,0
-- connect grid
g = grid.connect()
-- key function
g.key = function(x,y,z)
print(x,y,z)
lx = x
ly = y
lz = z*15
draw_grid()
end
-- simple draw function
draw_grid()
g.all(0)
g.led(lx,ly,lz)
g.refresh()
end
--------------------------------------------------------------------------------
help(grid) and help(clock) are pretty well fleshed-out, but there’s a ton of other modules which need documentation.
see brian’s changes for a great template for contributing to this effort
~/~/~/~/~/~/~/~/~/~/~/~/
new: command docs
~/~/~/~/~/~/~/~/~/~/~/~/
guiding principle: meatier than a quick reference and more direct than a study, reference docs give users who have gone through the studies but aren’t yet familiar with the ecosystem an actionable overview of the built-in modules.
provides illustrative + copy-paste’able code snippets to use in your own projects.
see the docs github for templates. if a module is preceded with lib. in the auto-gen api, then it goes in the lib folder 
have an idea for docs content? a whole new docs structure? please feel free to submit a PR to the docs github, or let us know here / help@monome.org 
