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

Panel: Add design documentation to readme #14504

Merged
merged 2 commits into from
Mar 19, 2019
Merged

Panel: Add design documentation to readme #14504

merged 2 commits into from
Mar 19, 2019

Conversation

davewhitley
Copy link
Contributor

@davewhitley davewhitley commented Mar 18, 2019

Initial commit to update Panel readme. These changes add design documentation.

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!

@davewhitley
Copy link
Contributor Author

For the dev documentation I moved the code block up, and I had to update the heading levels.

Copy link
Contributor

@kjellr kjellr left a comment

Choose a reason for hiding this comment

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

Looks great, thanks @drw158! 🚢

@kjellr kjellr merged commit e0cdf68 into master Mar 19, 2019
@kjellr kjellr deleted the update/panel-readme branch March 19, 2019 18:35
@kjellr kjellr added this to the 5.4 (Gutenberg) milestone Mar 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants