docs: remove the sponsors and update the READme #1770
Conversation
Sonalilipsa17375
requested review from
quetzalliwrites,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
@thulieblack I made the changes as suggested by you in #1762 , Could you please let me know if any improvement is needed . |
Sonalilipsa17375
changed the title
There was a problem hiding this comment.
@Sonalilipsa17375, great start.
Regarding the community repo and documentation, yes, I did point it out to the Community onboarding docs.
But I would like to see documents like Governance. MD, Charter. MD, and Community Goals file, which highlight the community organization and how we do things.
I hope this will provide some clarity
README.md
Outdated
|
|
||
| - Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). | ||
| - Go through the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md). | ||
| - Join our [AsyncAPI Docs Community](https://www.asyncapi.com/docs/community). |
There was a problem hiding this comment.
We don't have a docs community but docs is part of the community
There was a problem hiding this comment.
Thanks for the suggestions, I have incorporated this change.
README.md
Outdated
| - Go through the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md). | ||
| - Join our [AsyncAPI Docs Community](https://www.asyncapi.com/docs/community). | ||
| - Add the AsyncAPI calendar from the [AsyncAPI events](https://www.asyncapi.com/community/events) page to stay updated on meetings and events. | ||
| - Review the list of [technical writer contributor](https://www.asyncapi.com/docs/community/onboarding-guide/technical-writer-contributor-responsibilities) responsibilities to understand your role. |
There was a problem hiding this comment.
Only one link to TW onboarding is needed here. Community repo is not only for docs
There was a problem hiding this comment.
Yes updated it.
README.md
Outdated
| - Tutorials (take time to go through each tutorial) | ||
| - Reference | ||
| - Set up your local environment following the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md). | ||
| - Introduce yourself in AsyncAPI Slack in the **#01_introductions channel** and the #13_docs channel. Ask docs-related questions in #13_docs. |
README.md
Outdated
| - Reference | ||
| - Set up your local environment following the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md). | ||
| - Introduce yourself in AsyncAPI Slack in the **#01_introductions channel** and the #13_docs channel. Ask docs-related questions in #13_docs. | ||
| - Request a good first docs issue in the **#13_docs** [Slack channel](https://asyncapi.slack.com/ssb/redirect). |
There was a problem hiding this comment.
Same here, this is a community repo so it should reflect important community docs not for tech writers
There was a problem hiding this comment.
I have modified it, pls share your suggestions. @thulieblack
Sonalilipsa17375
force-pushed
the
readmeupdate
branch
from
5214fbb to
888dbcc
Compare
|
@thulieblack Can you pls rereview it, I have incorporated the changes you have suggested and also made many design changes. |
|
Hey @thulieblack, |
|
cc @TRohit20 |
README.md
Outdated
|
|
||
| - ### Getting Started | ||
| - **Spec Contribution:** [AsyncAPI Spec Guide](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) | ||
| - **Tools Contribution:** [AsyncAPI Tools Guide](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) |
There was a problem hiding this comment.
Do we wanna include only Spec and Tools contribution here? @thulieblack
There was a problem hiding this comment.
No this section we should remove
Links are working fine, as reviewed from my side. @TRohit20 If anything's required kindly suggest , I can implement those. |
There was a problem hiding this comment.
Great start, @Sonalilipsa17375. Some sections need to be removed, and others can be combined into one. The goal is to make the ReadMe simple but detailed.
README.md
Outdated
| --- | ||
|
|
||
| ## Community Goals 🎯 | ||
| Join us in 2025 as we boost maintainers, streamline onboarding, and create a structured Community Working Group Umbrella. Let's grow together through exciting initiatives like the AsyncAPI Grant Program, conferences, and mentorship. <br> |
There was a problem hiding this comment.
This section changes and relies on the community goals that change each year. Rather, make it dynamic
README.md
Outdated
| └───────────────────────────────┘ | ||
| ``` | ||
| --- | ||
| ## Community Documentation 📚 |
There was a problem hiding this comment.
This section should instead be part of the contributing section
README.md
Outdated
| 3. **Pick an Issue**: Choose an issue to work on and leave a comment introducing yourself. Feel free to ask questions if you're unsure how to get started. | ||
| 4. **Open a PR**: If no work has been done on the chosen issue, open a PR and start contributing! | ||
|
|
||
| ### Technical Writer Onboarding ✍️ |
There was a problem hiding this comment.
Put everything related to onboarding under one section
README.md
Outdated
|
|
||
| --- | ||
|
|
||
| ## Community Governance 🏛️ |
There was a problem hiding this comment.
Remove this section we are having a governance board soon
README.md
Outdated
|
|
||
| --- | ||
|
|
||
| ## Async API Technical Steering Committee (TSC) 👥 |
There was a problem hiding this comment.
Make the TSC and Ambassador sections into one. Maybe rename to "Becoming a TSC or an AsyncAPI Ambassador"
README.md
Outdated
|
|
||
| AsyncAPI Community uses **Slack as the source of communication**. It helps us stay closer to each other and to know each other better through discussions. | ||
|
|
||
| For more details, refer to our **[Slack Etiquette](./slack-etiquette.md)** guidelines. |
There was a problem hiding this comment.
This should also go under contributing or getting started.
README.md
Outdated
|
|
||
| ## Community Discussions 💬 | ||
|
|
||
| AsyncAPI Community uses **Slack as the source of communication**. It helps us stay closer to each other and to know each other better through discussions. |
There was a problem hiding this comment.
Actually, Slack isn't the only form of communication. Maybe it can be something to add in the beginning of the page under welcome.
README.md
Outdated
|
|
||
| ### Need Help? 🤝 | ||
|
|
||
| If you have any questions or need guidance, feel free to reach out through our **[Community Discussions](https://asyncapi.com/slack-invite)**. |
There was a problem hiding this comment.
Github discussions link shouldn't take you to slack
|
@Sonalilipsa17375 are you still working on the PR? |
WalkthroughThe README.md file was comprehensively rewritten, transforming it from a brief community introduction with sponsor details into a detailed AsyncAPI Community Guide. The updated document now includes a structured Table of Contents, explicit community goals for 2025, step-by-step contribution guidelines, governance information, details about the Technical Steering Committee, an ambassador program overview, and community discussion channels. The previous sponsor logos and meeting announcements were removed, and the new README is organized using headings, bullet points, and markdown diagrams for clarity. No code or exported entity changes were made. Changes
Assessment against linked issues
Possibly related PRs
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
28-34: Make Community Goals section dynamic
This section hard‑codes “2025” in the copy, which will become outdated. Consider using a templated include or linking to the goals document without specifying the year (e.g., “View our current Community Goals”).
🧹 Nitpick comments (9)
README.md (9)
5-9: Unify product naming in header and introduction
The header uses “AsyncAPI Community Guide” but the introduction refers to the “AsyncAPI Initiative.” Please confirm this aligns with our official branding (we generally use “AsyncAPI” as one word) and remains consistent throughout.
10-23: Verify Table of Contents links and adjust list indentation
The TOC uses emoji‑containing link fragments (e.g.,#community-goals-🎯), which may not resolve on all markdown renderers. Please verify each anchor works on GitHub. Also, adjust nested list indentation to two spaces per level to satisfy markdownlint MD007.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Link fragments should be valid
null(MD051, link-fragments)
13-13: Link fragments should be valid
null(MD051, link-fragments)
15-15: Link fragments should be valid
null(MD051, link-fragments)
16-16: Link fragments should be valid
null(MD051, link-fragments)
17-17: Link fragments should be valid
null(MD051, link-fragments)
18-18: Link fragments should be valid
null(MD051, link-fragments)
19-19: Link fragments should be valid
null(MD051, link-fragments)
20-20: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
20-20: Link fragments should be valid
null(MD051, link-fragments)
21-21: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
22-22: Link fragments should be valid
null(MD051, link-fragments)
23-23: Link fragments should be valid
null(MD051, link-fragments)
37-44: Fix heading levels and remove trailing punctuation
Heading at line 38 uses anh4(####) immediately after anh2(##), and ends with an exclamation mark, triggering markdownlint MD001/MD026. For proper hierarchy and style, use###and drop the trailing punctuation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
38-38: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
40-40: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
40-40: Headings must start at the beginning of the line
null(MD023, heading-start-left)
41-41: Unordered list indentation
Expected: 2; Actual: 6(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 6(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
43-43: Headings must start at the beginning of the line
null(MD023, heading-start-left)
44-44: Unordered list indentation
Expected: 2; Actual: 6(MD007, ul-indent)
64-84: Consolidate Community Documentation subsections
The “Community Documentation” section contains many nested headings and lists, which can be overwhelming. Consider breaking this into linked sub‑pages (e.g., “Onboarding Guide” vs. “Docs Contribution Guide”) to improve readability and maintainability.🧰 Tools
🪛 LanguageTool
[style] ~77-~77: Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...d leave a comment introducing yourself. Feel free to ask questions if you're unsure how to g...(FEEL_FREE_TO_STYLE_ME)
🪛 markdownlint-cli2 (0.17.2)
69-69: Headings must start at the beginning of the line
null(MD023, heading-start-left)
73-73: Headings must start at the beginning of the line
null(MD023, heading-start-left)
85-101: Consistent branding for “AsyncAPI Charter” and clean up punctuation
The link text uses “Async API Charter” (with a space) instead of our standard “AsyncAPI Charter”. Also, the subheading ends with a colon (:), violating MD026. Please update the branding and remove trailing punctuation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
89-89: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
89-89: Headings must start at the beginning of the line
null(MD023, heading-start-left)
89-89: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
91-91: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
92-92: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
93-93: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
94-94: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
95-95: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
96-96: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
97-97: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
98-98: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
99-99: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
114-126: Standardize TSC membership instructions
The TSC section mixes list levels and bold text, which hampers readability. Streamline by using clear heading hierarchy for “How to Be a Part of TSC” and “Meet the TSC,” and present the video and membership links in a consistent bullet format.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
125-125: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
129-133: Check Ambassador Program link target and branding
The “Async API Ambassador Program” heading may not match the file naming (AMBASSADOR_ORGANIZATION.md). Verify the link resolves correctly and update text to “AsyncAPI Ambassador Program” for consistency.
144-150: Clarify Community Discussions channel options
The text indicates Slack is the primary communication channel, but other venues (e.g., GitHub Discussions) exist. Consider renaming or expanding this section to accurately reflect all community discussion platforms.
151-158: Verify footer links and grouping
Please confirm that each footer link (GitHub, Slack, TSC, Ambassadors, Dashboard, Events, Newsroom) is accurate and consider grouping them under a “Resources” or “Community Links” heading to improve discoverability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
152-152: Headings must start at the beginning of the line
null(MD023, heading-start-left)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~77-~77: Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...d leave a comment introducing yourself. Feel free to ask questions if you're unsure how to g...
(FEEL_FREE_TO_STYLE_ME)
🪛 markdownlint-cli2 (0.17.2)
README.md
12-12: Link fragments should be valid
null
(MD051, link-fragments)
13-13: Link fragments should be valid
null
(MD051, link-fragments)
15-15: Link fragments should be valid
null
(MD051, link-fragments)
16-16: Link fragments should be valid
null
(MD051, link-fragments)
17-17: Link fragments should be valid
null
(MD051, link-fragments)
18-18: Link fragments should be valid
null
(MD051, link-fragments)
19-19: Link fragments should be valid
null
(MD051, link-fragments)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
20-20: Link fragments should be valid
null
(MD051, link-fragments)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Link fragments should be valid
null
(MD051, link-fragments)
23-23: Link fragments should be valid
null
(MD051, link-fragments)
38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
38-38: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
40-40: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
40-40: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
41-41: Unordered list indentation
Expected: 2; Actual: 6
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 6
(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
43-43: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
44-44: Unordered list indentation
Expected: 2; Actual: 6
(MD007, ul-indent)
69-69: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
73-73: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
89-89: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
89-89: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
89-89: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
91-91: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
92-92: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
93-93: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
94-94: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
95-95: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
96-96: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
97-97: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
98-98: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
99-99: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
106-106: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
106-106: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
109-109: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
109-109: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
125-125: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
152-152: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
🔇 Additional comments (1)
README.md (1)
45-63: Validate code‑block formatting in contribution steps
The ASCII‑style flow diagrams are a great visual aid. Please confirm that the code fences (```markdown) render as expected on GitHub and that the arrows and boxes remain aligned.
Yes mam, sorry I missed to reply , on time because of ongoing endsem exams. I will complete the work for sure, the changes you have mentioned. Will update you with the work by this week. |
Co-authored-by: V Thulisile Sibanda <[email protected]>
README.md
Outdated
|
|
||
| --- | ||
|
|
||
| ## Async API Technical Steering Committee (TSC) 👥 |
There was a problem hiding this comment.
Like this @Sonalilipsa17375
| ## Async API Technical Steering Committee (TSC) 👥 | |
| ## Becoming a TSC or an AsyncAPI Ambassador 👥 |
There was a problem hiding this comment.
Hi @Sonalilipsa17375. I provided some examples of the parts @thulieblack was referring to. :) Let me know if there’s other parts you need help with.
Yeah got it thanks for the reference @CBID2 |
Co-authored-by: Christine Belzie <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (1)
README.md (1)
144-149: Community Discussions Messaging
The note “uses Slack as the source of communication” overlooks GitHub Discussions. To reflect all channels and avoid past feedback (“Slack isn’t the only form of communication”), consider broadening this to mention Discussions alongside Slack.
🧹 Nitpick comments (8)
README.md (8)
37-44: Contributing Section: Heading Level and Punctuation
The line#### We love your input ! Contributing is easy and transparent.jumps two levels under the H2 and has an extra space before the exclamation mark. Consider changing####to###for proper nesting and removing the space before!.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
38-38: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
40-40: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
40-40: Headings must start at the beginning of the line
null(MD023, heading-start-left)
41-41: Unordered list indentation
Expected: 2; Actual: 6(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 6(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
43-43: Headings must start at the beginning of the line
null(MD023, heading-start-left)
44-44: Unordered list indentation
Expected: 2; Actual: 6(MD007, ul-indent)
48-63: Contribution Workflow Diagram Rendering
The ASCII art diagram is engaging but may not render consistently on all platforms. You might simplify it to a plain Markdown list or adopt a Mermaid flowchart for better cross-platform support.
65-71: Community Documentation & Contribution Guide Placement
The### How to Contribute to Our Docs 🛠line is indented by two spaces, triggering a markdownlint MD023 warning. Remove leading spaces so the heading starts at column 1.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
69-69: Headings must start at the beginning of the line
null(MD023, heading-start-left)
73-79: Getting Started Steps
The numbered list is clear and actionable. Ensure that any future edits maintain sequential numbering to avoid markdownlint MD029 warnings.🧰 Tools
🪛 LanguageTool
[style] ~77-~77: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...d leave a comment introducing yourself. Feel free to ask questions if you're unsure how to g...(FEEL_FREE_TO_STYLE_ME)
🪛 markdownlint-cli2 (0.17.2)
73-73: Headings must start at the beginning of the line
null(MD023, heading-start-left)
84-89: Our Charter Section Formatting
The subheading#### Key sections include:sits under an H2 and uses leading spaces. Convert it to### Key sections include(no leading spaces) to maintain proper heading hierarchy and satisfy markdownlint.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
89-89: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
89-89: Headings must start at the beginning of the line
null(MD023, heading-start-left)
89-89: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
127-135: Ambassador Program Section
Good overview. The horizontal rule before the heading at line 127 may not be necessary—consider removing it or ensuring similar spacing consistency with other sections.
141-142: Explore Link and Divider
The link text readsAsync API Ambassador Program—update toAsyncAPI Ambassador Program. Also, the---divider immediately after may be redundant; consider aligning its usage uniformly across sections.
152-154: Need Help Section Placement
This callout is useful—consider consolidating it with the “Community Discussions” section to centralize help resources and reduce fragmentation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
152-152: Headings must start at the beginning of the line
null(MD023, heading-start-left)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~77-~77: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...d leave a comment introducing yourself. Feel free to ask questions if you're unsure how to g...
(FEEL_FREE_TO_STYLE_ME)
🪛 markdownlint-cli2 (0.17.2)
README.md
12-12: Link fragments should be valid
null
(MD051, link-fragments)
13-13: Link fragments should be valid
null
(MD051, link-fragments)
15-15: Link fragments should be valid
null
(MD051, link-fragments)
16-16: Link fragments should be valid
null
(MD051, link-fragments)
17-17: Link fragments should be valid
null
(MD051, link-fragments)
18-18: Link fragments should be valid
null
(MD051, link-fragments)
19-19: Link fragments should be valid
null
(MD051, link-fragments)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
20-20: Link fragments should be valid
null
(MD051, link-fragments)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Link fragments should be valid
null
(MD051, link-fragments)
23-23: Link fragments should be valid
null
(MD051, link-fragments)
38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
38-38: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
40-40: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
40-40: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
41-41: Unordered list indentation
Expected: 2; Actual: 6
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 6
(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
43-43: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
44-44: Unordered list indentation
Expected: 2; Actual: 6
(MD007, ul-indent)
69-69: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
73-73: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
89-89: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
89-89: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
89-89: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
91-91: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
92-92: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
93-93: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
94-94: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
95-95: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
96-96: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
97-97: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
98-98: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
99-99: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
106-106: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
106-106: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
109-109: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
109-109: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
125-125: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
152-152: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
🔇 Additional comments (4)
README.md (4)
5-8: Title and Introduction Update Reviewed
The new H1 and welcome message clearly introduce the guide and set the tone for community engagement.
28-33: Community Goals Section
The new goals section is concise and links out to the detailed roadmap. Well structured—no issues here.
80-83: Technical Writer Onboarding
Clear and well-linked. No changes needed here.
159-159: Final Divider
The closing horizontal rule gives visual closure and matches the document’s structure.
|
@Sonalilipsa17375 I updated the readme based on your changes and the review. @CBID2 how does it look now? |
thulieblack
changed the title
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
README.md (3)
5-8: Consistent Heading Format and AccessibilityEmojis in headings can break anchor links in some Markdown renderers and may impact screen readers. Consider removing or relocating the emoji (e.g., move it after the heading text) to maintain accessible, valid heading anchors.
17-20: Refine Onboarding Section WordingThe sentence “Our community docs and onboarding section provides everything you need to get started contributing…” is a bit verbose. Consider a more direct phrasing, for example:
“Find all the resources you need to begin contributing.”
45-48: Verify Slack Invite LinkThe Slack invite URL (
https://asyncapi.com/slack-invite) currently issues a 301 redirect. Please confirm it lands on the correct invite page for users or update it to a direct invite link to avoid confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
README.md(1 hunks)
🔇 Additional comments (3)
README.md (3)
10-14: Validate Community Goals Link PathThe link
[More details »](./annual-goals)may need an explicit file extension or the correct path toannual-goals.md. Please verify that the target file exists at that path (and adjust to./annual-goals.mdif required) to avoid broken links.
31-33: Governance Section Looks GoodThe “Community Governance and Charter” section clearly explains the purpose and links to the governance docs. No changes needed here.
49-51: Check Community Calls URLsPlease verify that both the “Events & Meetings” and “AsyncAPI Conferences” links resolve correctly. Ensure they use the proper
https://prefix and adjust if any redirects or errors occur.
|
/rtm |
Description
Before - >>
After - >>
fixes: #1762
Related issue(s) - Link to the issue - #1762
Summary by CodeRabbit