Docs contributing and style guides #982
Closed
Conversation
This file contains hidden or 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
Add more info on how to contribute to JSON Schema documentation
Improve docs contribution guidance: Reference CONTRIBUTING-docs.md and style-guide.md
Add more info on how to contribute to JSON Schema documentation
…ebsite into web-feat-diataxis
These files document documentation contribution processes and style guidelines.
valeriahhdez
added
📝 Documentation
AnithaKraman
reviewed
Oct 2, 2024
kwennB
reviewed
Oct 2, 2024
There was a problem hiding this comment.
Thank you for the great work @valeriahhdez, I have added a couple of comments.
|
|
||
| ### Example | ||
| All code should be written and not included in the documentation as images. |
There was a problem hiding this comment.
Following Google's Sentence structure guide, I recommend rewording to "All code should be written and not included as images in the documentation.
AnithaKraman
reviewed
Oct 2, 2024
AnithaKraman
reviewed
Oct 2, 2024
AnithaKraman
reviewed
Oct 2, 2024
AnithaKraman
reviewed
Oct 2, 2024
AnithaKraman
reviewed
Oct 2, 2024
AnithaKraman
reviewed
Oct 2, 2024
|
|
||
| The reviewers might ask for additional changes. When the reviewers approve your pull request, you can merge your changes into the main branch and your contribution to the project will be complete! | ||
|
|
||
| We created this guide based on templates from [The Good Docs Project](https://www.thegooddocsproject.dev/). |
There was a problem hiding this comment.
I believe that this sentence is the last line of the documentation guide, however, visually it appears to be part of the last section 'Create a pull request'.
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Oct 3, 2024
AnithaKraman
reviewed
Nov 5, 2024
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.
What kind of change does this PR introduce?
Documentation contribution workflows and expectations are documented in the file CONTRIBUTING-docs.md. For style guidelines, we adopted the Google developers style guide and documented instructions for using markdown tags. This is now documented in the file md-style-guide.md. We hope these documents help docs contributors get started and create consistent documentation.
Issue Number: #902
Screenshots/videos:
If relevant, did you update the documentation?
Summary
Does this PR introduce a breaking change? No