Block Editor Handbook: Improved the readability and phrasing and corrected mistakes#48756
Conversation
Corrected weird and awkward phrasings and sentences, and made some things more specific. Some examples and thoughts behind the changes: Why would the Block Editor documentation link to the Block Editor documentation. I'm already there right? We're linking to the How-To guides. Or why do we write Block Inserter capitalized, but not Block Editor? Sometimes the order of words was just plain weird. "you will find here guides to help you" There was a quick link, just before the heading Quick Links, which didn't make sense to me. Also, it's one of the first links in the documentation and it links away from the documentation to a support article so that asks for a bit more context. Clearly stating you're going away from dev focussed content to end-user focussed content.
Contributor
|
The whole case issue around Gutenberg is really annoying. I have seen this problem too. Some is an uppercase letter for each word and some is sentence format. |
Author
I agree, wonder how this is handled in WordPress docs. Might need a global document where we define what gets capitalized and what doesn't. I also see Block and block everywhere, same goes for Editor and editor. |
ryanwelcher
reviewed
Mar 10, 2023
ryanwelcher
requested changes
Mar 10, 2023
Contributor
ryanwelcher
left a comment
There was a problem hiding this comment.
Just a small change then I think we're good to go!
aristath
approved these changes
Mar 24, 2023
Member
aristath
left a comment
There was a problem hiding this comment.
LGTM!
There was a failing test preventing this from getting merged but it's not related this PR, so I restarted the test and once it passes we can merge this 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrected weird and awkward phrasings and sentences, and made some things more specific.
Some examples and thoughts behind the changes:
Why would the Block Editor documentation link to the Block Editor documentation. I'm already there right? We're linking to the How-To guides.
Or why do we write Block Inserter capitalized, but not Block Editor?
Sometimes the order of words was just plain weird. "you will find here guides to help you"
There was a quick link, just before the heading Quick Links, which didn't make sense to me. Also, it's one of the first links in the documentation and it links away from the documentation to a support article so that asks for a bit more context. Clearly stating you're going away from dev focussed content to end-user focussed content.