Docs: Add how to guide documentation template #36694
Merged
Conversation
This file contains 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
ajlende
reviewed
Dec 3, 2021
- 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
Co-authored-by: Alex Lende <[email protected]>
mkaz
force-pushed
the
docs/add-howto-template
branch
from
92d5229
to
bac0163
Compare
ajlende
approved these changes
Dec 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Adds a template document for how to guides to help standardize the document structure and format. We want to improve the Gutenberg documentaiton by making it more consistent and use a standard structure across different documents.
Templates help learners when using the documentation to know what to expect; and also helps writers by showing what to include and a structure on how to create a guide.
The template is based on from The Good Docs Project, there are additional open-source templates provided in their template repository that we can use as a starting point for additional templates.
How has this been tested?
Types of changes
NOTE: This is a stacked commit and relies on #36689 being merged first.