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: Clarify best practices surrounding color palette names #14989

Closed
aduth opened this issue Apr 15, 2019 · 1 comment · Fixed by #15006
Closed

Documentation: Clarify best practices surrounding color palette names #14989

aduth opened this issue Apr 15, 2019 · 1 comment · Fixed by #15006
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers

Comments

@aduth
Copy link
Member

aduth commented Apr 15, 2019

Related:

Current documentation: https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/themes/theme-support.md

The editor-color-palette theme supports enable a theme developer to specify a custom color palette for their themes. Each color should include a name, slug, and color values.

The current documentation neither describes each value, nor importantly does it set clear guidelines around the purpose a name should fulfill in providing human-friendly (and accessible) labels describing the color.

Per the related ticket, it may be good to include guidance around dynamic values (such as those sourced from a site option). For example, while not all dynamic values could be described programmatically, it may be advisable to provide meaningful names for at least the default values when applicable.

@aduth aduth added [Type] Developer Documentation Documentation for developers Good First Issue An issue that's suitable for someone looking to contribute for the first time labels Apr 15, 2019
@nickylimjj
Copy link
Contributor

nickylimjj commented Apr 16, 2019

Am picking this one up. Will submit a PR by Apr 18!

@gziolo gziolo added the [Status] In Progress Tracking issues with work in progress label Apr 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants