Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve & add documentation #454

Closed
trentgill opened this issue Nov 18, 2021 · 6 comments
Closed

improve & add documentation #454

trentgill opened this issue Nov 18, 2021 · 6 comments
Milestone

Comments

@trentgill
Copy link
Collaborator

trentgill commented Nov 18, 2021

input[n].mode = 'clock' is undocumented

should appear here but there is no reference.

@trentgill trentgill added this to the 3.1? 3.5? 4.0? milestone Feb 3, 2023
@trentgill trentgill changed the title input[n].mode = 'clock' is undocumented improve & add documentation Feb 3, 2023
@trentgill
Copy link
Collaborator Author

trentgill commented Feb 3, 2023

from #464

@trentgill
Copy link
Collaborator Author

other new features already in main:

@trentgill
Copy link
Collaborator Author

trentgill commented Feb 3, 2023

all the currently open PRs that are soon to be merged need docs added to the main page. most of them have extensive usage & examples in the PRs, but need to be distilled into documentation. it probably makes sense to capture them in some kind of blog-post style introduction -- perhaps linked to my website or a lil stub page on the monome site? unsure where that stuff should live.

there is an additional PR about i2c reliability (#458) but something is already merged (#457). not sure what's going on there.

// EDIT

this is now included in main

and testing should be based on the timeline PR noted here. @dndrks let me know if you have issues downloading the file or uploading the firmware!

download firmware: (you'll need to be logged into github to download. got to Pull Requests tab. Click on dev4.0, scroll to the bottom, find "All checks have passed" and click on "Show all checks" to the right. Then click "details" in the pop-down. Then click "Summary" in the top-left. Then at the centre-bottom click on the crow-#######.zip to download the firmware.)

@dndrks note the link above has changed as of 2/22 ~3pm EST so timeline should work correctly.

@dndrks
Copy link
Member

dndrks commented Feb 23, 2023

raaaad, these are all amazing additions to an already-fantastic toolkit!!

re:

[...] perhaps linked to my website or a lil stub page on the monome site? unsure where that stuff should live.

i'd love to keep these on the monome site with the rest of the scripting docs, if you're okay with it? also totally happy to build supplemental materials and just to links out to your write-ups, but since folks will likely email [email protected] with clarifying q's over their ownership, it'd be nice to not have to task you with updates + addendums.

@trentgill
Copy link
Collaborator Author

Yeah i'd be totally happy for them to live on the monome docs site. Mostly just conscious that the conversational style isn't quite aligned with the rest of the docs. Very happy if you want to edit them into something a little more straightforward / with less assumptions :)

@trentgill
Copy link
Collaborator Author

Closing this as all the info is now in the monome docs. there's still more to do with editing / tidying up / re-organization, but the docs are now up-to-date with the 4.0 release, so let's start a new issue if there's specific issues that arise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants