docs(community): update latest community documentation #3818
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
quetzalliwrites
as code owners
WalkthroughThis pull request adds a new entry in the JSON configuration file and introduces two new documentation pages. The configuration update extends the list of available resources by including a style guide reference. Additionally, a new onboarding guide for maintainers and a formatting guide for documentation standards are added under the community documentation section. Changes
Possibly related PRs
Suggested labels
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.
|
Markdown Check ResultsWe found issues in the following markdown files: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3818 +/- ##
=========================================
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 (4)
markdown/docs/community/styleguide/formatting.md (4)
15-25: Improve Consistency in Bullet List Formatting and Style
Consider the following adjustments to enhance consistency and clarity in the "Notes and warning blocks" section:
- Replace asterisks (
*) with dashes (-) in the bullet lists to follow markdownlint's recommended style.- At line 18, capitalize Markdown when referring to the documentation language.
- At line 19, add a comma after “Currently” for improved readability.
Example diff:
- Use an `>` in markdown to indicate the nature of the note or warning. + Use an `>` in Markdown to indicate the nature of the note or warning. - Use the following syntax to apply a style. Currently our documentation supports **Remember** `<Remember>`: + Use the following syntax to apply a style. Currently, our documentation supports **Remember** `<Remember>`: - * Surround the text you want to style with an opening <Remember> tag and a closing </Remember> tag. - * Note that the word 'Remember' does not need to be included within the tags, as it automatically provides the necessary styling. - * Use the following syntax to apply a style: + - Surround the text you want to style with an opening <Remember> tag and a closing </Remember> tag. + - Note that the word 'Remember' does not need to be included within the tags, as it automatically provides the necessary styling. + - Use the following syntax to apply a style:🧰 Tools
🪛 LanguageTool
[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)
🪛 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)
23-23: Spaces inside code span elements
null(MD038, no-space-in-code)
32-43: Specify Language for Fenced Code Blocks
To meet markdownlint guidelines, add a language identifier to fenced code blocks. For example, change the code block delimiter on line 38 as shown below:- ``` + ```bashThis will ensure proper syntax highlighting in examples.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
55-63: Add Language Identifier to JavaScript Code Block
The JavaScript snippet demonstrating a function should include a language specifier for clarity. For instance, modify the opening fence on line 55:- ``` + ```javascriptThis enhances readability and aligns with best practices for code block annotations.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
55-55: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
67-75: Consistent Unordered List Marker
For consistency with the rest of the document and to satisfy markdownlint rules, replace asterisks with dashes in unordered lists. For example, update the items on lines 67 and 75 as follows:- * Use this syntax to apply a style: + - Use this syntax to apply a style: - * The output: + - The output:🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
67-67: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
75-75: 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 (3)
config/edit-page-config.json(1 hunks)markdown/docs/community/onboarding-guide/Onboarding-maintainer-guide.md(1 hunks)markdown/docs/community/styleguide/formatting.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
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)
🪛 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)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (4)
config/edit-page-config.json (1)
22-29: New JSON Entry for Community Styleguide Added
The new entry for"community/styleguide"is correctly added with the expected URL. Please verify that the link points to the intended documentation directory and follows the project's URL conventions.markdown/docs/community/onboarding-guide/Onboarding-maintainer-guide.md (1)
1-68: Comprehensive Onboarding Guide for Maintainers
This new document is well-structured and clearly outlines the responsibilities, steps, and resources for AsyncAPI maintainers. The headings, bullet lists, and embedded links help create an accessible and informative guide for new contributors.markdown/docs/community/styleguide/formatting.md (2)
1-5: YAML Front Matter is Properly Configured
The YAML metadata block correctly defines the title, description, and weight for the document.
7-11: Introduction Section is Clear
The introduction provides a concise overview of documentation formatting and outlines the elements that contribute to the document's readability.
akshatnema
deleted the
update-community-docs-5288a808571f2c70b4b7e665cdbf4111f77b2f0d
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit