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

Documentation: Sidebar Rules Menu/TOC grouping #403

Open
ststimac opened this issue Mar 5, 2018 · 2 comments
Open

Documentation: Sidebar Rules Menu/TOC grouping #403

ststimac opened this issue Mar 5, 2018 · 2 comments
Assignees
Labels

Comments

@ststimac
Copy link
Member

ststimac commented Mar 5, 2018

We should update the table of contents for the rules so that there is a sub-category, i.e. a11y, and then the grouping for those rules under than sub category.

If you're in the documentation looking at rules it's not a good user experience if you only want to be exploring a certain category but the menu of rules in the sidebar isn't group by category/doesn't explicitly state what category the rule is in/is listed alphabetically .

@ststimac ststimac self-assigned this Mar 5, 2018
@ststimac ststimac changed the title Documentation: Rule Menu/TOC grouping Documentation: Sidebar Rules Menu/TOC grouping Mar 5, 2018
@ststimac
Copy link
Member Author

ststimac commented Aug 8, 2018

I'm not sure how long this issue would take to do & what all needs to be done with the way the TOC currently gets pulled in.

We would be restructuring the table of contents to group hints by their main category. I think the ability to collapse different hint categories in the TOC would be helpful as well so there isn't just a massive list visible.

@ststimac
Copy link
Member Author

Task list:

  • group hints by parent hint category
  • make accessible

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

No branches or pull requests

1 participant