Teletype docs enhancements (redesign in progress)

tehn · 2017-10-10T14:02:21.083Z

i’ll be sure to make time to review the code-- though it won’t be exhaustive.

and then i’m happy to merge pretty quickly-- i’ll test the newest candidate. the older candidates were working well. but let’s make sure the PR fits the guidelines re: formatting etc-- you seem to be on that.

i’m happy to get 2.1 out for people to use-- it also opens the path for @scanner_darkly to release the grid ops.

cmcavoy · 2017-10-10T15:15:17.837Z

sliderule:

I’m not sure if @tehn, @cmcavoy, or yourself would have enough time in the next while to review some ~2700 lines of changes in any meaningful sense, so I have to presume that my PR will be accepted carte blanche for all intents and purposes.

Unfortunately, I don’t have the skills to do reviews for the project, just suggest ways to organize things.

scanner_darkly · 2017-10-10T18:57:30.657Z

i should be able to take a quick look.

papernoise · 2017-10-10T19:04:04.493Z

late to the party since I’m moving right now… but great work on the cheatsheet @sam!

Dogma · 2017-10-11T17:53:54.529Z

so is 2.1 available as yet?

sliderule · 2017-10-11T19:38:02.845Z

2.1.0 will be released tomorrow.

If you’d like to try it sooner than that, you can check out RC2 which is 100% code-compatible with 2.1.0-release.

sam · 2017-10-12T14:47:22.345Z

I’ve pushed my cheatsheet branch:

https://github.com/samdoshi/teletype/tree/cheatsheet

I’ll rebase and PR once 2.1 is merged.

jlmitch5 · 2017-10-12T16:17:45.741Z

Also been working with @sam on getting the version from the git tags rather than hard coding (ended up doing this for both the prompt on the teletype itself and the html/pdf docs). Definitely some cleaning up still needed, but plan is to get this in shortly after the cheatsheet branch gets merged in. Commit here

This will be my first C contribution (albeit a very tiny one), but I’m pretty excited about that! Shoutout to Sam for a lot of guidance on how I should approach this.

sam · 2017-10-13T08:13:55.197Z

I have rebased my branch on to master@monome/teletype and opened up a PR:

github.com/monome/teletype

Add cheat sheet

by samdoshi on 08:11AM - 13 Oct 17 UTC

1 commits changed 9 files with 227 additions and 24 deletions.

Here is the PDF (now with Turtle OPs included!): cheatsheet.pdf (65.9 KB)

Unless I hear otherwise I will hit the merge button myself in approx. 24 hours.

jlmitch5 · 2017-10-13T14:31:35.683Z

@sam looks like it’s been merged, nice! I’ll open up a pr against master with the version changes we’ve talked about this evening.

scanner_darkly · 2017-10-19T21:50:55.832Z

looks like some of the docs that were removed from the teletype page did not make it into the new manual, specifically USB flash drive scene read/write that can be seen as part of Teletype 1.1 Addendum here: https://web.archive.org/web/20170609025605/http://monome.org/docs/modular/teletype/

could somebody re-add that section? or if somebody could point me to what’s the latest process for editing the docs is i can add it (is it just editing toml/md files?).

tehn · 2017-11-12T14:13:22.674Z

re: usb drive saving:

missed this on the first round, was going to bring it up from a related thread.

if someone has a minute, thanks! else i’ll get it in next week.

unity2k · 2017-11-13T03:52:11.670Z

sam:

I think that default scenes are much more useful for brand new Teletypes than firmware upgrades

But sometimes new users are performing firmware upgrades fairly soon and I for one would still find some default scenes helpful.

unity2k · 2017-11-13T03:56:41.998Z

Please add parameters, options, and recommended editors (such as Notepad++ or whatever they might be) for saving scenes as saving it as a simple .txt file out of Open Office didn’t work for me.

tehn · 2017-11-13T13:46:26.768Z

@unity2k re editors, if you list which work (i know there was a thread here somewhere) i’ll add them to the docs.

unity2k · 2017-11-13T13:49:55.326Z

tehn:

if you list which work (i know there was a thread here somewhere) i’ll add them to the docs.

That’s the problem, I don’t know and can’t find it though I have stumbled across it before.

tehn · 2017-11-13T13:52:08.621Z

ok, one search did it.

Teletype script editing offline Monome

has anyone edited scripts offline (on a computer) and had success/failure reading them into teletype with a usb stick? i suspect there will be issues with different text editors and formatting. this wasn’t necessarily a feature i was intending, also. if you’d like to share a tt scene, please attach the file as to preserve formatting-- otherwise the file will likely need to be retyped (which is probably good for learning the script). but in general, i expect the file handling code needs to be …

the short answer, it doesn’t really work. don’t expect it to until there’s a firmware update.

tambouri · 2017-11-13T23:04:09.754Z

Sorry for some absence here (it’s been a wild couple of work months), but I’ve been slowly trying to get some doc improvements into the quickstart/overview section. I found it kind of tricky to break the gist of the original doc up much differently so this is mostly insertions, revisions, tweaks and a lot of @jlmitch5 coaching me on using git through the command line.

Anyway, I think I’ve been working on this in my own head for a little too long, so I’d like to solicit any feedback or suggestions for further revisions. Thanks!

@sam i know you are probably swamped w/ parenthood, but I knew on the OPs docs you gave me some pointers regarding formatting, I tried to apply these here, but would appreciate a glance as I’m sure I’m still missing some best practices

jlmitch5 · 2017-11-14T01:06:51.734Z

Awesome!

I think that somewhere, your diagrams went missing. If you add them back in, commit and push (no need to use force as you aren’t rewriting history), it should be good!

tambouri · 2017-11-14T02:40:02.395Z

Whooops, I’m thinking these are hopefully still on my work computer. Otherwise I have the illustrator files and I can spit them back out again!