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

Enforce heading sentence case throughout the BEH #57143

Merged
merged 7 commits into from Dec 18, 2023

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented Dec 17, 2023

This PR is not exhaustive, but it is a first step in enforcing sentence case for all headings throughout the Block Editor Handbook. This is in accordance with the documentation style guide.

Edit: While updating the Explanations → Architecture → Styles in the Editor doc, I also took the liberty of removing the unnecessary TOC and fixing the heading hierarchy. I missed this in #57087

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Dec 17, 2023
@ndiego ndiego self-assigned this Dec 17, 2023
Copy link

github-actions bot commented Dec 17, 2023

Flaky tests detected in ce674db.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7241631320
📝 Reported issues:

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

These changes make sense to me too, but I'd like to leave a comment with some typo corrections or suggestions.

Also, in the document style guide, there is a rule called "Always capitalize proper nouns.".

For example, which rule do you think should be followed in this PR?

  • Block supports or Block Supports?
  • Global styles of Global Styles?

docs/explanations/architecture/styles.md Show resolved Hide resolved
docs/explanations/architecture/styles.md Show resolved Hide resolved
docs/explanations/architecture/styles.md Show resolved Hide resolved
docs/explanations/architecture/styles.md Show resolved Hide resolved
docs/how-to-guides/README.md Outdated Show resolved Hide resolved
docs/how-to-guides/internationalization.md Outdated Show resolved Hide resolved
docs/reference-guides/richtext.md Outdated Show resolved Hide resolved
docs/explanations/user-interface/block-design.md Outdated Show resolved Hide resolved
ndiego and others added 4 commits December 18, 2023 09:16
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
@ndiego
Copy link
Member Author

ndiego commented Dec 18, 2023

Thanks for reviewing @t-hamano and fixing my typos 🤦‍♂️

@t-hamano t-hamano self-requested a review December 18, 2023 15:27
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ndiego ndiego enabled auto-merge (squash) December 18, 2023 15:44
@ndiego ndiego merged commit 1f42ec7 into trunk Dec 18, 2023
52 checks passed
@ndiego ndiego deleted the docs/use-sentence-case-in-headings branch December 18, 2023 15:46
@github-actions github-actions bot added this to the Gutenberg 17.4 milestone Dec 18, 2023
artemiomorales pushed a commit that referenced this pull request Jan 4, 2024
* Enforce heading sentence case.

* Linting

* Update title and remove unnecessary TOC

* Update docs/how-to-guides/README.md

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>

* Update docs/reference-guides/richtext.md

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>

* Update docs/explanations/user-interface/block-design.md

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>

* Update docs/how-to-guides/internationalization.md

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>

---------

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
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.

None yet

2 participants