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

[a11y] Component accessibility documentation #1050

Closed
dpersing opened this issue Feb 15, 2019 · 1 comment
Closed

[a11y] Component accessibility documentation #1050

dpersing opened this issue Feb 15, 2019 · 1 comment
Assignees
Labels
Accessibility Needs design, development, or content work relating to accessibility.

Comments

@dpersing
Copy link
Contributor

dpersing commented Feb 15, 2019

Want to add a quick PR to help improve our documentation? Want to support accessibility work in Polaris? Do I have the project for you.

Check out the project history for more details.

See all of the drafts including content for guides and patterns, for copy.

How to do it

  1. If you want to do some writing, check out components in the To do or Outlined sections.
  2. If you want to do some editing, see Written.
  3. If a component's documentation has been edited and is ready for a PR, go ahead and open one. Keep an eye out for documentation that references other components; we'll want to make sure those references get released together or are already out.
  4. If you want to review open PRs, take a look at Open PRs.

Formatting content

The component docs live in the README.md file for the component. To add a section, add this snippet to the end of the README.me file:

---

## Accessibility

<!-- content-for: android -->

See Material Design and development documentation about accessibility for Android:

- [Accessible design on Android](https://material.io/design/usability/accessibility.html)
- [Accessible development on Android](https://developer.android.com/guide/topics/ui/accessibility/)

<!-- /content-for -->

<!-- content-for: ios -->

See Apple’s Human Interface Guidelines and API documentation about accessibility for iOS:

- [Accessible design on iOS](https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/accessibility/)
- [Accessible development on iOS](https://developer.apple.com/accessibility/ios/)

<!-- /content-for -->

<!-- content-for: web -->

...Your new content...

<!-- /content-for -->

Check out the merged PRs for examples.

Questions?

Ask @dpersing about things in general or ask @sadiesaurus about content/editing specifically.

Status

To do

Outlined

Written

Open PRs

Merged

@dpersing dpersing self-assigned this Feb 15, 2019
@alex-page alex-page added Accessibility Needs design, development, or content work relating to accessibility. and removed Accessibility labels Apr 17, 2019
@alex-page
Copy link
Member

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accessibility Needs design, development, or content work relating to accessibility.
Projects
None yet
Development

No branches or pull requests

2 participants