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

Helping README readability and fixing minor typo/grammar issues #10590

Merged
merged 5 commits into from Nov 14, 2018

Conversation

Projects
None yet
5 participants
@postphotos
Contributor

postphotos commented Oct 14, 2018

Description

I've chiseled at each section inside the main readme.md to make each section a tad more readable. I've added bolded text, fixed em dashes, fixed the Matt M. pullquote styles, added subtitles to make reading at a glance easier, cleaned up the "employee" example and hinted at the next two phases a bit more clearly.

Rationale: This document, paramount to the rest, should be quick to read.

How has this been tested?

N/A.

Screenshots

Types of changes

Perhaps it's a fix. It's changes to the Readme.

Checklist:

  • [N/A] My code is tested.
  • [N/A] My code follows the WordPress code style.
  • [N/A] My code follows the accessibility standards.
  • [N/A] My code has proper inline documentation.
@postphotos

This comment has been minimized.

Contributor

postphotos commented Oct 16, 2018

Hi per this Slack thread, I'm pinging @mtias @karmatosed as it looks like you both have done a lot of work on this doc.

Can you (or someone else, feel free to direct me there) give this a read? I've tried to improve the general readability of the main README.md a bit further.

I think users would appreciate this, thanks! 😄

@tofumatt tofumatt requested a review from WordPress/gutenberg-core Oct 21, 2018

README.md Outdated
One thing that sets WordPress apart from other systems is that it allows you to create as rich a post layout as you can imagine -- but only if you know HTML and CSS and build your own custom theme. By thinking of the editor as a tool to let you write rich posts and create beautiful layouts, we can transform WordPress into something users _love_, as opposed something they pick it because it's what everyone else uses.
One thing that sets WordPress apart from other systems is that it allows you to create a post layout as rich as you can imaginebut only if you know HTML and CSS and build your own custom theme. By thinking of the editor as a tool that can let you both write rich posts and create beautiful layouts, we can transform WordPress into something users _love_, as opposed something they pick because it happens to be what everyone else uses.

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

It was in the original text, but 'as opposed something' seems like a mistake. Shouldn't it be 'as opposed to something', or 'instead of something'.

This comment has been minimized.

@kristastevens

kristastevens Oct 23, 2018

Hello @talldan, thanks for the copy review ping. Here's a suggestion to add a couple of words that seem to be missing and streamline the text just slightly.

Suggested change Beta
One thing that sets WordPress apart from other systems is that it allows you to create a post layout as rich as you can imagine—but only if you know HTML and CSS and build your own custom theme. By thinking of the editor as a tool that can let you both write rich posts and create beautiful layouts, we can transform WordPress into something users _love_, as opposed something they pick because it happens to be what everyone else uses.
One thing that sets WordPress apart is that it allows you to create a post layout that's as rich as you can imagine—but only if you know HTML and CSS and can build your own custom theme. By thinking of the editor as a tool that allows you to write rich posts **and** create beautiful layouts, we can transform WordPress into something users _love_, as opposed to something they choose because it happens to be what everyone else uses.
README.md Outdated
Gutenberg looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade. This allows us to holistically design a modern editing experience and build a foundation for things to come.
**Gutenberg is a new way forward.** It looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade. This project allows us to holistically design a modern editing experience, and build a foundation for things to come.

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

I've seen a bit of discussion recently about using 'us' or 'we', which doesn't read very inclusively. It could be something to change here.

Using 'the WordPress community' as a replacement might be an idea.

This comment has been minimized.

@kristastevens

kristastevens Oct 23, 2018

Looks great! I have a minor quibble with the revision in that stylistically, there isn't a need for a comma after "experience" as the word "and" acts as a natural pause.

README.md Outdated
3. When singular block interface takes center stage, it demonstrates a clear path forward for developers to create premium blocks, superior to both shortcodes and widgets.
4. Considering the whole interface lays a solid foundation for the next focus, full site customization.
5. Looking at the full editor screen also gives us the opportunity to drastically modernize the foundation, and take steps towards a more fluid and JavaScript-powered future that fully leverages the WordPress REST API.
1. **The block unifies multiple interfaces.** If we add that on top of the existing interface, it would _add_ complexity, as opposed to removing it.

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

'Introducing blocks as part of the existing editor would add complexity'

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

Also noting we use 'as opposed to' here 😄

This comment has been minimized.

@kristastevens

kristastevens Oct 23, 2018

For clarity, what are we referring to when we say, "that" in the first sentence [If we add "that"...]? I found that sentence confusing.

![Writing in Gutenberg 1.6](https://make.wordpress.org/core/files/2017/10/gutenberg-typing-1_6.gif)
## Blocks
Blocks are the unifying evolution of what is now covered, in different ways, by shortcodes, embeds, widgets, post formats, custom post types, theme options, meta-boxes, and other formatting elements. They embrace the breadth of functionality WordPress is capable of, with the clarity of a consistent user experience.
Imagine a custom employee block that a client can drag to an About page to automatically display a picture, name, and bio. A whole universe of plugins that all extend WordPress in the same way. Simplified menus and widgets. Users who can instantly understand and use WordPress -- and 90% of plugins. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.
Imagine a custom `employee` block that a client can drag onto an `About` page to automatically display a picture, name, and bio of all the employees. Imagine a whole universe of plugins just as flexible, all extending WordPress in the same way. Imagine simplified menus and widgets. Users who can instantly understand and use WordPressand 90% of plugins. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

I think it's worth removing the definitive article here, since these employees haven't been previously established in the writing.
'display a picture, name, and bio of all the employees.' -> 'display a picture, name, and bio of employees.'

This comment has been minimized.

@kristastevens

kristastevens Oct 23, 2018

Just a couple small suggestions here.

Suggested change Beta
Imagine a custom `employee` block that a client can drag onto an `About` page to automatically display a picture, name, and bio of all the employees. Imagine a whole universe of plugins just as flexible, all extending WordPress in the same way. Imagine simplified menus and widgets. Users who can instantly understand and use WordPress—and 90% of plugins. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.
Imagine a custom `employee` block that a client can drag onto an `About` page to automatically display a picture, name, and bio. Imagine a whole universe of plugins just as customizable, all extending WordPress in the same way. Imagine simplified menus and widgets. Imagine a scenario where Users can instantly understand and use WordPress—and 90% of plugins. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.
Gutenberg has three planned stages. The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual.
Gutenberg has three planned stages.
1) **The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience** and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual. These foundational elements will pave the way forward.
2) Planned for 2019, **The second stage focuses on overhauling The Customizer** and page templates.

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

It wonder if it might be worth asking for a brief description here from the leads? 'overhauling' is quite an extreme word, and it also implies the customizer lives on, whereas really we could be imagining and exploring entirely new ways to theme and customize.

This comment has been minimized.

@kristastevens

kristastevens Oct 23, 2018

Nothing to suggest here.

Gutenberg has three planned stages.
1) **The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience** and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual. These foundational elements will pave the way forward.
2) Planned for 2019, **The second stage focuses on overhauling The Customizer** and page templates.
3) Ultimately, **full site customization** will be possible.

This comment has been minimized.

@talldan

talldan Oct 23, 2018

Contributor

I don't know if we want to talk about the third phase and onwards yet, so it might be worth not mentioning it.

This comment has been minimized.

@kristastevens

kristastevens Oct 23, 2018

Nothing to suggest here.

@talldan

This comment has been minimized.

Contributor

talldan commented Oct 23, 2018

Thanks for working on this @postphotos!

I've added some comments, but seeing as I mostly write JavaScript and not English, take my comments as just suggestions or conversation starters instead of changes that need to be made 😄

tofumatt added some commits Nov 14, 2018

@tofumatt tofumatt self-assigned this Nov 14, 2018

tofumatt added some commits Nov 14, 2018

@tofumatt

Thanks for this! I'm for these changes and will merge them after Travis is green.

@tofumatt tofumatt merged commit 80dafcf into WordPress:master Nov 14, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

grey-rsi pushed a commit to OnTheGoSystems/gutenberg that referenced this pull request Nov 22, 2018

Helping README readability and fixing minor typo/grammar issues (Word…
…Press#10590)

* Fixing minor typos and readability issues to help with documentation

* chore: Make it clear what "core" is

* docs: Tweak README links

* docs: Integrate suggestions

* docs: "We" tweaks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment