docs(community): update latest community documentation #3819
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
quetzalliwrites
as code owners
WalkthroughThis pull request updates the project documentation and configuration by adding new resources. A new JSON entry linking to a community style guide has been added to the configuration file. Additionally, three new documentation files have been introduced: onboarding guides for AsyncAPI Ambassadors and Maintainers, and a Formatting guide outlining documentation standards. Changes
Possibly related PRs
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
asyncapi-bot
requested review from
Aahil13,
VaishnaviNandakumar,
ashmitjsg and
sambhavgupta0705
❌ Deploy Preview for asyncapi-website failed.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3819 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 21 21
Lines 667 667
Branches 113 113
=========================================
Hits 667 667 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
markdown/docs/community/onboarding-guide/ambassador-guide.md (1)
28-29: Language Clarity Improvement
The bullet “- Be in tune with AsyncAPI's mission and values.” (line 29) could be simplified. Consider rephrasing it to “- Align with AsyncAPI's mission and values.” for clearer and more concise language.🧰 Tools
🪛 LanguageTool
[style] ~29-~29: ‘in tune with’ might be wordy. Consider a shorter alternative.
Context: ...ole year. ### Ambassador duties - Be in tune with AsyncAPI's mission and values. - Always...(EN_WORDINESS_PREMIUM_IN_TUNE_WITH)
markdown/docs/community/onboarding-guide/maintainer-guide.md (1)
27-29: Grammar Suggestion: Add a Comma for Clarity
In the sentence on line 28, consider inserting a comma after “others” – for example: “You’ll mentor others, not just by answering questions but by teaching contributors why coding standards matter…” This improves readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: Possible missing comma found.
Context: ...r others not just by answering questions but by teaching contributors why coding s...(AI_HYDRA_LEO_MISSING_COMMA)
markdown/docs/community/styleguide/formatting.md (5)
18-19: Capitalization and Punctuation in Instructions
In the bullet “- Use an>in markdown to indicate the nature of the note or warning.” (line 18), “markdown” should be capitalized as “Markdown” since it is a proper noun. Also, in the following bullet (line 19), consider adding a comma after “Currently” for clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~18-~18: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...uage simple and direct. - Use an>in markdown to indicate the nature of the note or w...(MARKDOWN_NNP)
[uncategorized] ~19-~19: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... the following syntax to apply a style. Currently our documentation supports Remember...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
20-22: Consistent Unordered List Markers
The nested list items in the “Notes and warning blocks” section currently use asterisks. For consistency with markdownlint guidelines (MD004), consider replacing these asterisks with dashes. For example:- * Surround the text you want to style with an opening <Remember> tag and a closing </Remember> tag. + - Surround the text you want to style with an opening <Remember> tag and a closing </Remember> tag.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
20-20: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
21-21: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
22-22: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
38-38: Specify Language for Fenced Code Block
The fenced code block starting on line 38 does not specify a language. To enhance syntax highlighting and adhere to markdownlint (MD040), add an appropriate language identifier (e.g., “```bash”).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
55-55: Fenced Code Block Should Include a Language Identifier
The code fence that begins on line 55 (which contains the JavaScript example) should specify the language. For improved readability and tooling support, consider changing “” to “javascript”.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
55-55: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
67-67: Replace Asterisks in Nested Lists for Consistency
The nested unordered list items at lines 67 and 75 use asterisks. In order to comply with markdownlint’s preference for dashes (MD004), please update these markers accordingly.Also applies to: 75-75
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
67-67: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
config/edit-page-config.json(1 hunks)markdown/docs/community/onboarding-guide/ambassador-guide.md(1 hunks)markdown/docs/community/onboarding-guide/maintainer-guide.md(1 hunks)markdown/docs/community/styleguide/formatting.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/community/onboarding-guide/ambassador-guide.md
[style] ~29-~29: ‘in tune with’ might be wordy. Consider a shorter alternative.
Context: ...ole year. ### Ambassador duties - Be in tune with AsyncAPI's mission and values. - Always...
(EN_WORDINESS_PREMIUM_IN_TUNE_WITH)
markdown/docs/community/styleguide/formatting.md
[style] ~16-~16: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ing to introduce the note or warning. - Use short paragraphs or bullet points to co...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~18-~18: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...uage simple and direct. - Use an > in markdown to indicate the nature of the note or w...
(MARKDOWN_NNP)
[uncategorized] ~19-~19: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... the following syntax to apply a style. Currently our documentation supports Remember...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
markdown/docs/community/onboarding-guide/maintainer-guide.md
[uncategorized] ~28-~28: Possible missing comma found.
Context: ...r others not just by answering questions but by teaching contributors why coding s...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/styleguide/formatting.md
20-20: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
21-21: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
22-22: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
23-23: Spaces inside code span elements
null
(MD038, no-space-in-code)
38-38: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
55-55: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
67-67: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (2)
config/edit-page-config.json (2)
22-25: New Onboarding Guide Entry Added
A new JSON object for the community onboarding guide has been introduced. Please verify that the naming ("community/onboarding-guide") and URL are consistent with other similar entries.
26-29: New Styleguide Entry Added
The new entry for "community/styleguide" is added with the expected URL. Confirm that this URL is up-to-date with the repository structure and that its value naming is consistent with the rest of the configuration.
akshatnema
deleted the
update-community-docs-101d358e7ef0a0ecfbd3c34cac92ad5cf64d331a
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation