Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs ui work #167

Merged
merged 3 commits into from Nov 12, 2018
Merged

Docs ui work #167

merged 3 commits into from Nov 12, 2018

Conversation

@jlmitch5
Copy link
Contributor

@jlmitch5 jlmitch5 commented Nov 3, 2018

Updates the html docs template based on community feedback.

See the docs live here. Changes include:

Navigation area (table of contents)

  • updated background color
  • make x button part of side nav pane (and remove header)
  • change “what’s new” section to updates
  • expand second level of navigation when a header link is clicked
    • update selected/expanded links based on url hash on refresh/linking
  • update link styling
    • underline on hover
    • dark when not focused
    • blue when focused
    • last 3 items should have smaller font
    • remove title link
    • add separators between reference materials/quickstart and advanced/last 3 items

Main content area

  • left align (with padding) text. still should have max-width
  • remove copy to clipboard on hover of headers (same sort of functionality by clicking navigation links)
  • restyle h1-h3 headers (title, primary nav level, secondary nav level respectively)
  • update paragraph text
  • update monospace fonts, and inline and multi-line code block background
  • migrate tables to more responsive list style
    • inline code blocks should not have background/padding
    • for ops/mods consolidate table with short descriptions and lists with long description into one
      • if there’s a long description display it, if there’s a short but no long, display short, if there’s neither display -

Followed up changes after initial pass:

  • fixed scrolling stopping on iOS
  • fixed unordered list rendering
  • fixed wrapping of ops “tables” (lists) with android chrome
  • fixed back button not updating state/location using hashchange fn
  • tweaked css and styling to reduce prominence of sidebar based on additional feedback
  • made shorthand name use consistent for external devices (full manufacturer company/product vs. shorthand)
  • made mobile make menu toggle sticky.
  • added separator between content and start of table
  • gridified alpha ops again, with one column for code, and one column for short description
  • updated alpha ops ops column header to have smaller and italic font.

TODOs still remaining:

  • update tab title and add favicon @tehn let me know if you need anything from me here when you push to monome's site.
  • make sure PDF docs render as they use to (some table changes affected the PDF docs, I'll need to fix those.

For later (will not be a part of this pr)

  • move git hash/version. would be good to show but not as heavily in the title
  • add reference materials section (links to cheatsheet, etc.)
  • improve ux of toggling/untoggling primary nav links
jlmitch5 added 3 commits Nov 3, 2018
…rthand
@tehn tehn merged commit 7c1808a into monome:master Nov 12, 2018
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@tehn
Copy link
Member

@tehn tehn commented Nov 12, 2018

amazing! uploading to main site now.

is there a finished pdf uploaded somewhere already?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants