docs: adding documentation writing guidelines #9366
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
robert-zaremba
requested review from
aaronc,
alessio,
amaury1093,
blushi,
cyberbono3,
ryanchristo,
technicallyty,
atheeshp,
aleem1314 and
likhita-809
ryanchristo
approved these changes
May 20, 2021
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
robert-zaremba
added
the
A:automerge
mergify bot
pushed a commit
that referenced
this pull request
May 25, 2021
* docs: adding documentation writing guidelines * update * Apply suggestions from code review Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> Co-authored-by: likhita-809 <78951027+likhita-809@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
github-actions
bot
removed
the
T:Docs
|
let this one fall off my radar, thanks for doing this work @robert-zaremba |
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
Was hanging for a long time and emerged during extraordinary documentation reviews by @barriebyron .
It's not complete but at least it provides a good base with links to the resources we should use.
closes: #8906
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes