-
Notifications
You must be signed in to change notification settings - Fork 841
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
Adds a11y docs #2357
Adds a11y docs #2357
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added comments, questions and suggestions to the Google doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall we should add some Do/Don't panels to accompany and illustrate each section. There's just a lot of text and no "Do this, not that" type of examples that I think most devs will look for.
I feel like these guidelines are held together with hot glue in the design department. It's mostly ok if you just look at the rendered page but I use a lot of inline styles and the spacing around the code examples is a little wonky. If anyone has ideas on how to clean this up, I'm all ears. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @myasonik I don't have time to go through this today and will be out tomorrow. We definitely shouldn't be changing sass for a guidelines page that only live in docs.
There's also other issues that you've pointed out. With its text heavy format this feels really close to an education-focused blog post rather than an example-driven guideline as we've generally provided. We can probably take what's here and move it in that direction, but it'll require some design work and some cycles.
I can help next week.
Jumping back in here now data grid is mostly done. Gimme a day or two to do a pass. |
OK. This took too long, my apologies, but happy Thanksgiving? I did a fairly large cleanup of the layout that were mostly visual. The following changes were needed:
I think the content here is much improved and is likely good enough to merge. I still think it could use with some trimming, but I appreciate all the examples that are now in the document and it's much more readable. This should get a review from @cchaos or another designer before merge since I'll be away. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm finding mostly layout issues and others that are just easier to fix on my end.
Also add tests for `heading`
Heading shifts for better TOC
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cchaos Do you think this is good to merge? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, LGTM, thanks @myasonik !!
Summary
Adds a bunch of accessibility guidelines. Hopefully people will read them.
The docs here are the same as the Accessibility Guidelines Google doc.
Checklist
- [ ] Checked in dark mode- [ ] Checked in mobile- [ ] Checked in IE11 and Firefox- [ ] Props have proper autodocs- [ ] Added or updated jest tests- [ ] Checked for breaking changes and labeled appropriately- [ ] Checked for accessibility including keyboard-only and screenreader modes