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

Docs: Update documenation contributors guide with doc types #36689

Merged
merged 2 commits into from
Dec 3, 2021

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Nov 20, 2021

Description

Update documentation contributor guide explaining the different documentation types.

The documentation was organized into sections by type but the contributor guide was not updated to reflect the types or reasoning for each. This PR adds those explanations.

How has this been tested?

Documentation update.

  • Confirm the explanation is clear
  • Check for spelling or typos
  • Confirm links work

Types of changes

Documentation

  • Adds new section that explains how the documentation is organized around types
  • Updates headings to match sentence case as recommended
  • Minor text tweaks and updates

- Adds new section that explains how the documentation is organized around types
- Updates headings to match sentence case as recommended
- Minor text tweaks and updates
@mkaz mkaz requested a review from ajitbohra as a code owner November 20, 2021 16:05
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Nov 20, 2021
Copy link
Contributor

@ajlende ajlende left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@mkaz mkaz merged commit f0fc7c7 into trunk Dec 3, 2021
@mkaz mkaz deleted the docs/update-contrib-types branch December 3, 2021 17:59
@github-actions github-actions bot added this to the Gutenberg 12.2 milestone Dec 3, 2021
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