Teletype Docs UX Enhancements

[jlmitch5]

Not ready for merge!

This PR makes some UX enhancements to the pandoc generated HTML5 Teletype docs.

Things fixed in this PR:

• stick TOC on left hand side of window
  • for mobile, hide behind hamburger icon
• better responsiveness of wide tables (see Variables table in OPs and MODs section
  • currently, wide tables overflow the horizontal width of smaller screens.
  • I’ve updated things to fill better across screen sizes. The tables are still not great, but they are usable.
• target=“_blank” on links off of docs
  • In past projects I’ve worked on, we’ve decided that links outside of the content you are currently looking at should open in a new tab so as to prevent context switching.
• anchor link next to doc sections (allowing for linking of specific sections of the docs)
  • this shouldn’t be difficult because it’s already reflected in the URL as a hash
• Update .editorconfig
• Update h1 and h3-in-code-element css weirdness that got added

---

Things I didn't get to.

• Quantization scale content is repeated
  • It’s fine that it’s repeated visually, need to see if the content is repeated in the repo…could lead to change drift
• Include footnote sources under relevant sections (rather than at the bottom of the docs)
  • Not a big deal…if this isn’t a 5-minute fix, I’ll probably push this one out.
• Explore the ability to export each section to it’s own .HTML file (not sure if that’s possible).
• Enhancements to TOC
  • make full width (and click-link-to-close) for more narrow browser widths
  • highlight when hovering over a particular nav element in the TOC.

[samdoshi]

Did you mean to make this change to the column headers?

[samdoshi]

As above, did you intend to change the column headers?

[jlmitch5]

@tehn @samdoshi I'm now comfortable merging this, if y'all could give a quick review.

Happy to squash commits if you'd like me to (I think they're fairly semantic, but this is also a fairly small PR so they could be squashed to a single one too...y'alls call).

I did rebuild the pdf with the table changes and they seem good: