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 redesign - new navigation structure + theming #103

Closed
ghost opened this issue Dec 30, 2021 · 5 comments
Closed

Docs redesign - new navigation structure + theming #103

ghost opened this issue Dec 30, 2021 · 5 comments
Labels
✏️ documentation Improvements or additions to documentation
Milestone

Comments

@ghost
Copy link

ghost commented Dec 30, 2021

New designs

Sidebar changes:

  • a nicer experience for mobile and tablet users - a collapsable menu you can summon from anywhere on the page (instead of scrolling back to the top)
  • new section headings to better surface our pages
  • a nicer a e s t h e t i c in keeping with our retro theme 😎

Primary nav changes:

  • a new purple background to match our new theme

Documentation content changes:

  • a dull purple background to match our new theme

Mobile and tablet breakpoints

Note: These should match with the breakpoint(mobile) and breakpoint(tablet) values under our SCSS functions

image

Desktop and above

image

Code changes

  • we'll likely need a new mixin to represent those nav section headings. I say "mixin" since it'll be a combo of font-family, text-transform to all caps, and wider letter-spacing. I'm open to any naming scheme here; maybe subheading or decorative-heading?
  • we currently assume all visitors have the Monaco font on their device, but this probably isn't sustainable! We should probably find this font face and add it to our assets/fonts directory.
  • the docs.11tydata.js will need a new data structure to support section headings. The section headings shown in the mockup are intended for production (it's not dummy data!), so structure our data to support that. i18n is out of scope.
@ghost ghost added the ✏️ documentation Improvements or additions to documentation label Dec 30, 2021
@ghost ghost added this to the Docs redesign milestone Dec 30, 2021
@ghost
Copy link
Author

ghost commented Dec 30, 2021

To be completed after #102

@brycewray
Copy link

@Holben888 Re your second bullet under "Code changes," you could try something similar to what Tailwind uses for monospaced type, unless you require that code will look exactly the same regardless of OS or device (e.g., so all zeroes will look the same):

font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;

@ghost
Copy link
Author

ghost commented Dec 31, 2021

@brycewray Ah that's fair! But we are using Monaco as a heading font as well, so not just code snippets. I'd prefer to get the same look across device now that it's a decorative font.

@nachtfunke
Copy link
Collaborator

I think after merging #167, everything described in this issue is done! I meant to reference this issue in my PR but I referenced the wrong issue.

@ghost
Copy link
Author

ghost commented Feb 11, 2022

No prob! I agree 😁

@ghost ghost closed this as completed Feb 11, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✏️ documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants