Teletype docs enhancements (redesign in progress)

alanza · 2018-11-03T00:10:11.195Z

okay Git hygiene question; is editing whatever version of the 3.0 docs okay, or is there a particular branch I should fork from?

scanner_darkly · 2018-11-03T02:11:00.866Z

heads up, i’ve just merged @alphacactus’s PR which includes new doc for J and K variables, if you use master branch make sure to pull the latest!

alanza · 2018-11-03T04:13:39.419Z

@jlmitch5 I just noticed, the table has left column label "OP includes set notation and aliases". The latter part of that should (a) not be bolded (my goto here would be smaller font, italics and parentheses but maybe that’s overkill) and (b) maybe something should be done so it doesn’t increase the width of the left column quite so severely.

You guys I am learning so much Git by doing this it’s great. And once I’m actually up and editing I’ll learn so much more Teletype!

alanza · 2018-11-03T14:35:29.890Z

is it all right if I also editorialize away from x y z for OP argument letters in some instances? Especially in cases where another letter or short string would be more descriptive, I think this will help the documentation’s legibility.

I say “is it all right”, but I’m going ahead and making that change on my branch xD

EqualTemperament · 2018-11-03T15:22:03.969Z

Seems to me like there’s already a precedent for doing this - at least in the cheat sheet / command reference. Grid ops don’t really follow the x y z pattern. E.g.

G.BTX id x y w h type level script columns rows

I think it would make some of them more readable.

scanner_darkly · 2018-11-03T16:55:01.238Z

alanza:

Especially in cases where another letter or short string would be more descriptive

this would be great, as it would also improve consistency between different ops.

EqualTemperament:

Grid ops don’t really follow the x y z pattern

for grid ops x and y specifically mean the x/y control coordinates, so made sense to name the parameters accordingly (and i thought w and h are pretty self explanatory in this context too).

alanza:

once I’m actually up and editing I’ll learn so much more Teletype!

i had more than one occasion of “oh didn’t know there was an op for that!” while looking at the code

jlmitch5 · 2018-11-03T18:53:13.374Z

@tehn PR up! I can fix PDF building as part of this PR or right after, whichever works. Let me know if you need anything.

@alanza thanks for the feedback, I fixed the header, I think:

Screen Shot 2018-11-03 at 2.40.52 PM.png1005×438 37.5 KB

EqualTemperament · 2018-11-03T19:06:20.762Z

Thanks a ton for your efforts here!

Leverkusen · 2018-11-03T21:53:19.096Z

jlmitch5:

@Leverkusen should be. link is https://teletype-docs.now.sh

I still can’t use this on neither my iPhone nor the iPad. I am on iOS 9 on both of them and I am sure there was a previous version, that worked though.

jlmitch5 · 2018-11-03T22:08:00.156Z

I’ll see if I can pull up a cross browser testing tool and check iOS 9. Latest does work on iOS 12 for sure.

I removed all newer style js I was using when I cleaned up the code, so I’m puzzled as to what it could be.

If you have the ability to pull up the console on safari and tell me if you see any error messages, that would be helpful.

47C608C8-D893-4655-9EC6-16A74ED498B9.jpg1125×2436 376 KB

jlmitch5 · 2018-11-04T00:14:36.572Z

actually, pretty sure I know what’s wrong—need to convert forEach to standard for loops. I moved that code from an isolated script tag to the main area, which is why it would have worked before and stopped working once I made that change. I’ll let you know when I’ve made that update

jlmitch5 · 2018-11-04T01:12:24.536Z

@Leverkusen I updated that code and pushed the changes. Could you check again? Thanks for following back up on that!

Leverkusen · 2018-11-04T09:11:06.016Z

It works on the iPhone now. The link you provided always brings me to the expanded menu, tapping a heading there brings me to the right chapter.

On the iPad I see the same expanded menu and it is not blue anymore as it was in the screenshot I posted above. Tapping on the headers/links does nothing but I can collapse the menu now by tapping on the cross and than I have the full documentation. I tried if I get to different points of the documentations when I tap the menu headers before I close the menu but I always get to the beginning.

Both devices are on the same version of iOS 9 so it might be the iPad that is wrong here somehow.

jlmitch5 · 2018-11-04T16:37:06.340Z

Awesome glad it works better. I will see if I can figure out about the iPad issue.

alphacactus · 2018-11-12T04:35:00.171Z

just wanted to chime in and say thank you for these changes. the iOS fix in particular is really nice.

jlmitch5 · 2018-11-18T18:42:11.530Z

just a note there is a PR up to fix the PDF table rendering that I broke https://github.com/monome/teletype/pull/168

scanner_darkly · 2019-02-11T19:54:17.645Z

looks like page up / page down buttons don’t work in firefox (edge and chrome seem to be fine). could somebody try with firefox to confirm it’s not my local issue?

unrelated request, would it be possible to add shortcut for keybindings to the menu?

jlmitch5 · 2019-02-11T21:00:51.533Z

scanner_darkly:

unrelated request, would it be possible to add shortcut for keybindings to the menu?

Sure–what do you have in mind?

scanner_darkly · 2019-02-11T21:04:40.723Z

there is Keys section (https://github.com/monome/teletype/blob/master/docs/keys.md) - i think it would be good to have a separate menu item for it on the left for quick navigation, as it’s something used often.

jlmitch5 · 2019-02-11T21:07:48.502Z

O gotcha–for some reason I thought you meant adding shortcuts to the web docs themsevles, heh.

That seems fairly easy. I’m already doing some manual hacking to display certain things in specific ways in there, so I think adding another one shouldn’t be too difficult. Will add to my todos (or if someone wants to take a stab at it, happy to help guide).