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 block conventions #16458

Merged
merged 4 commits into from Jul 8, 2019

Conversation

@sarahmonster
Copy link
Member

commented Jul 8, 2019

In response to confusion in #16118 and #16002, this introduces two small documentation changes to be more explicit about the conventions we follow:

  • Naming conventions when referring to blocks in documentation or elsewhere in the UI.
  • The verb + subject format used for block descriptions.

I tried to be as clear and succinct as possible here, but I'm natually wordy (and I think examples are probably extremely helpful here). If there are bits we can clarify or trim down, happy to revise!

@sarahmonster sarahmonster requested review from mkaz and chrisvanpatten Jul 8, 2019

@mkaz

mkaz approved these changes Jul 8, 2019

Copy link
Member

left a comment

👍 Rebasing to 🤞 pass tests

@mkaz mkaz force-pushed the docs/clarify-block-conventions branch from c4e6779 to 2d112e7 Jul 8, 2019

sarahmonster and others added some commits Jul 8, 2019

Update docs/designers-developers/designers/block-design.md
Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com>

@mkaz mkaz force-pushed the docs/clarify-block-conventions branch from 2d112e7 to dfb25f3 Jul 8, 2019

@mkaz mkaz merged commit 7de6bf3 into master Jul 8, 2019

1 of 2 checks passed

Filter merged Filter merged
Details
Travis CI - Pull Request Build Passed
Details

@mkaz mkaz deleted the docs/clarify-block-conventions branch Jul 8, 2019

jg314 added a commit to jg314/gutenberg that referenced this pull request Jul 19, 2019

Documentation: Clarify block conventions (WordPress#16458)
* Establish explicit naming convention for blocks in UI & docs.

See WordPress#16118.

* Elaborate on sentence format for block descriptions.

Vaguely related: WordPress#16002.

* Update docs/designers-developers/designers/block-design.md

Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com>

* Minor copyedit to Block Description section.

@youknowriad youknowriad added this to the Gutenberg 6.2 milestone Jul 26, 2019

sbardian added a commit to sbardian/gutenberg that referenced this pull request Jul 29, 2019

Documentation: Clarify block conventions (WordPress#16458)
* Establish explicit naming convention for blocks in UI & docs.

See WordPress#16118.

* Elaborate on sentence format for block descriptions.

Vaguely related: WordPress#16002.

* Update docs/designers-developers/designers/block-design.md

Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com>

* Minor copyedit to Block Description section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.