docs: add Grammar section to AsyncAPI Style Guide #1749
Closed
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
Fixes #1691 Add a new Grammar section to the AsyncAPI Style Guide. * **Create new file**: Add `asyncapi.com/docs/community/styleguide/grammar.md` to house the Grammar section. * **Abbreviations and Acronyms**: Define guidelines for using abbreviations and acronyms. * **Active Voice**: Explain the importance of using active voice and provide examples. * **Capitalization**: Detail rules for capitalizing titles, headings, and specific terms. * **Spelling**: List common spelling conventions and preferred spellings for specific terms. * **Verb Tense**: Outline appropriate verb tenses to use in different contexts.
Recxsmacx
requested review from
quetzalliwrites,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
Recxsmacx
changed the title
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.
Fixes #1691
Add a new Grammar section to the AsyncAPI Style Guide.
asyncapi.com/docs/community/styleguide/grammar.mdto house the Grammar section.