agreed (and it seems as though, at least for patterns, some have been copy/pasted into the new docs). I would probably personally remove these from the landing page (because they’re really getting at “how to use” teletype effectively, not “what teletype does”)…that being said, totally could go either way :+1:

yes, this is the main question at hand. currently the 2.0 doc has no form of introduction to the language and screens, which the existing intro does. the pattern commands are there simply to give context to the tracker screen.

so the question is: where should the sections PANEL up until COMMAND SET live? should they stay on the landing page? or should they be the first section of the 2.0 doc? or should they stay, as a sort of addendum quickstart to the video which is the banner?

and then COMMAND SET and on gets moved to the 2.0 doc (“manual”) and adjusted properly? there’d be a link to the manual way up in the INTRODUCTION however, with the other links.

FYI GitHub pages can do all of this for you, the only thing one needs to do is publish the site’s contents (can be markdown or restructuredtext) and (optionally) do some styling. GitHub will then build the static files and host/serve them.
This can also be done on any domain.

Ah so I’m thinking I was wrong now that I’ve dove a bit deeper.

I felt like patterns in the new docs was pretty close to having all the useful info from the landing page (and could be augmented with some of the old stuff to augment if wanted):

Modes are more terse references in the new docs and could probably use some intro from the old docs above their tables.


But this line of thinking sort of falls apart when you get to the scenes…there isn’t really a section in the new docs that goes into that (and I could see how that belongs on the landing page now…it sort of allows someone who has never seen teletype to wrap there hands around how triggers + sets of commands = useful musical stuff.)

i’ve been thinking through this a bit too, and has been part of the sticking point w/ moving forward productively in a limited time scenario (apologies) w/ the intro page

here’s what i’d been thinking. and loosely beginning

monome/teletype page

intro
-video
-description
-pic
-link to 2.0 docs

2.0 docs (might not hurt if a small part of this is redundant in case someone gets here first)

intro
-vid
-description
-pics
-panel
-links

quick start (in my head this could be a mix of the current intro and something to match that patterns page in new docs at which point that could get pulled out of the OPs section for consistency)
-live mode
-edit mode
-patterns
-pattern mode
-scene mode

command set
-…

not sure if this has been addressed but in 2.0 html the “modes” section kind of seems like a misnomer. I think that you could call that section something like “Global and modal key-bindings” (if that makes sense). And would also then make more sense if this was preceded w/ a "quickstart section that included these same modes.

1 Like

I am intending to make a command reference PDF cheatsheet sort of thing. Most likely by creating a custom LaTeX template or some such.

My limited “computer time” is currently being used to set up a new computer. Once that’s done I’ll probably have some more time for Teletype stuff (including this).

1 Like

Indeed they are modal on the Just Friends side. The commands are entered in the same manner, though have different meaning depending on Just Friend’s speed switch.

o and sort-of related @Galapagoose–are the docs that you were/are working on post-3.0 for Just Friends gonna be on the whimsical raps’ site (as linked to in the latest change), or are they gonna be a part of the open-sourcing/github side of things?

first draft is up.

https://monome.org/docs/modular/teletype

the manual is linked from here.

i’ve also merged my docs PR into the teletype repo. can someone who has installed pandoc make the pdf so i can upload it? i haven’t downloaded the 3gig pandoc thing still.

very much in need of proofreading, clarification edits, and suggestions as this new documentation is a bit of a patchwork assembly, whereas the previous docs started from nothing and as a result had a cohesive flow. of course they were wildly out of date, so this new system has major advantages.

next i’ll proof the tt-studies for out of date information.

we need an updated reference chart and key chart if anyone can take this on. does anyone here have a talent for chart layouts?

6 Likes

yay! Here’s the pdf:

teletype.pdf (434.9 KB)

5 Likes

thanks! it’s live on the main site

1 Like

On page 11 is says that the ~ (tilde) key will bring the user into Tracker mode, but I believe this has been replaced with the Num Lock key

I appreciate the great afford of eversone working on this!

Just wanted to mention that the pdf links on the table of contents still don’t lead to the right chapters.

2 Likes
1 Like

@leverkusen ah yea, thanks for bringing this back up.

I checked it in preview for Mac OS back when you had posted and wasn’t seeing any sort of hyper-linkage between the TOC and the content sections on the pdf there. What PDF reader are you using?

@Leverkusen o wait, seems like @sam might have been able to reproduce.

I a using the MacOS implemted viewer for everything - when I click on a topic in the TOC I get somewhere in the topic before the chosen one.

2 Likes

Now I see it (on 10.13)!..I think I might have been using my other computer to test (10.11) and I wonder if that version of Preview doesn’t have clickable TOC…or maybe I just did a bad job of trying to reproduce (which is highly possible, hah).

Anyways, thanks for filing! A little outside of my expertise, but I’ll take a look soon and see if there’s anything obvious with our pandoc PDF generation config (if @sam doesn’t get to it before me).

1 Like

Getting the same problem on Linux / Google Chrome 61.0.3163.91 (Official Build) (64-bit)

1 Like

I could do something along the lines of these ones: http://www.papernoise.net/papernoise-cheatsheets/

2 Likes