GithubHelp home page GithubHelp logo

improve & add documentation about crow HOT 6 CLOSED

trentgill avatar trentgill commented on July 17, 2024
improve & add documentation

from crow.

Comments (6)

trentgill avatar trentgill commented on July 17, 2024 1

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.

  • timeline #447
  • hotswap #456
  • qscale library #452 [pushed to 4.1]

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

  • sequins transformers #449

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.

from crow.

trentgill avatar trentgill commented on July 17, 2024

from #464

  • add documentation for changing ii address #441
  • improve documentation for unique_id function [not sure what this means]

from crow.

trentgill avatar trentgill commented on July 17, 2024

other new features already in main:

  • ii "high-reliability" mode #457
  • sequins string mode #446
  • math.rand vs math.srand #442
  • sequins current value inspect #436

from crow.

dndrks avatar dndrks commented on July 17, 2024

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.

from crow.

trentgill avatar trentgill commented on July 17, 2024

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 :)

from crow.

trentgill avatar trentgill commented on July 17, 2024

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.

from crow.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.