Skip to content

Components: update CheckboxControl readme - #14153

Merged
karmatosed merged 2 commits into
masterfrom
update/checkbox-docs
Mar 15, 2019
Merged

karmatosed merged 2 commits into
masterfrom
update/checkbox-docs

Conversation

@davewhitley

@davewhitley davewhitley commented Feb 27, 2019 •

Copy link
Copy Markdown
Contributor

Description

This PR adds design guideline documentation in addition to the development documentation that existed previously. These guidelines are 'best practices' for the usage of the component, as well as describing the component in more detail.

Screenshots

A preview can be seen here, although it doesn't represent what it will look like in the handbook:

preview

Feedback

I'd appreciate feedback on:

  • Whether my markdown syntax is correct
  • Design guidelines
  • Double-checking a11y of the document
  • Seeing if the design guidelines align with the development documentation

Thank you!

These changes add design documentation.
@davewhitley davewhitley added [Type] Enhancement A suggestion for improvement. [Type] Developer Documentation Documentation for developers Needs Design Feedback Needs general design feedback. Needs Technical Feedback Needs testing from a developer perspective. Needs Accessibility Feedback Need input from accessibility labels Feb 27, 2019
@davewhitley

Copy link
Copy Markdown
Contributor Author

Sorry about all of the requested reviews. I didn't do that so it must be an automated thing?

@davewhitley

Copy link
Copy Markdown
Contributor Author

The images do not have alt description because if the images were removed, the content would not lose any value (except for maybe the first image?).

ref:(#11226 (comment))

A11y feedback on this would be great.

@aduth

aduth commented Mar 11, 2019

Copy link
Copy Markdown
Member

Sorry about all of the requested reviews. I didn't do that so it must be an automated thing?

It's part of the code owners workflow implemented in the project. All those assigned had volunteered themselves to be assigned.

See also:

@davewhitley

Copy link
Copy Markdown
Contributor Author

@karmatosed This PR does not have a design or a11y review, but I think it should be good to merge once an owner approves.

@karmatosed

Copy link
Copy Markdown
Member

@drw158 I agree and I will now approve. We can (and should) iterate, but it's important to get these in.

@karmatosed
karmatosed self-requested a review March 15, 2019 14:37
@karmatosed
karmatosed merged commit 7723b06 into master Mar 15, 2019
@aduth
aduth deleted the update/checkbox-docs branch March 15, 2019 14:45
@youknowriad youknowriad added this to the 5.3 (Gutenberg) milestone Mar 18, 2019
youknowriad pushed a commit that referenced this pull request Mar 20, 2019
* Initial commit to update CheckboxControl readme

These changes add design documentation.

* Fix tabbing on code example
youknowriad pushed a commit that referenced this pull request Mar 20, 2019
* Initial commit to update CheckboxControl readme

These changes add design documentation.

* Fix tabbing on code example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Accessibility Feedback Need input from accessibility Needs Design Feedback Needs general design feedback. Needs Technical Feedback Needs testing from a developer perspective. [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants