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

feat: Improve navigation structure #986

Merged
merged 4 commits into from
May 17, 2019
Merged

feat: Improve navigation structure #986

merged 4 commits into from
May 17, 2019

Conversation

dcramer
Copy link
Member

@dcramer dcramer commented May 16, 2019

  • Auto expand most top level categories
  • Bring design into alignment with readme

@dcramer
Copy link
Member Author

dcramer commented May 16, 2019

image

Copy link
Contributor

@MimiDumpling MimiDumpling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@cameronmcefee
Copy link
Contributor

cameronmcefee commented May 16, 2019

Style

As a professional designer and person responsible for our brand, I'm not super thrilled about intentionally trying to copy Readme. May of these changes feel like personal taste rather than things that are objective improvements. I would presume there are ways to get the usability benefits without completely copying their flavor.

Sidebar

  • Expanded categories seem fine.

  • Button states seem incomplete.

  • Contrast needs improvement.

Search in the header

I'm into it. I've wanted to go that direction. Is it intentional that the search doesn't work in mobile?

Misc

There seems to be a handful of arbitrary formatting changes, a handful of which make things harder to understand.

Copy link
Member Author

@dcramer dcramer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with feedback on design changes, but I don't want the docs to be design-y (for lack of better terms). I think Readme does an excellent job in terms of usability out of the box, better than we have done. I realize thats subjective, and I'm ok with that as basically most things in design will end up being subjective.

  • Search should be hidden on mobile, which doesn't need to be a priority for docs.
  • Formatting changes would be due to automated tools like Prettier.

@@ -49,4 +49,4 @@ $breadcrumb-margin-bottom: 0;
$border-width: 2px;

$btn-font-size: 1rem;
$btn-font-size-sm: 0.875rem;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just realized this wasn’t base don’t size will revert

@dcramer dcramer force-pushed the feat/improve-nav branch from 5e29043 to b9bbf82 Compare May 16, 2019 20:34
- Auto expand most top level categories
- Bring design into alignment with readme
@dcramer dcramer force-pushed the feat/improve-nav branch from b9bbf82 to 3715926 Compare May 16, 2019 20:55
@dcramer
Copy link
Member Author

dcramer commented May 16, 2019

More fixes, and darkened text in sidebar

image

@dcramer
Copy link
Member Author

dcramer commented May 16, 2019

image

@dcramer dcramer merged commit 3d734cc into master May 17, 2019
@dcramer dcramer deleted the feat/improve-nav branch May 17, 2019 15:54
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants