docs(community): update latest community documentation #4374
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
thulieblack
as code owners
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis PR standardizes internal documentation links (removing .md extensions, switching to repo-relative or GitHub blob URLs), updates several mentorship-related names, streamlines one docs community page by removing meeting details, and expands the Code of Conduct Committee page with additional incident-resolution bullet points. No code or exported/public entity changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4374 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4374--asyncapi-website.netlify.app/ |
asyncapi-bot
deleted the
update-community-docs-18bef573228f09fe668e7c57f98d78834221d43a
branch
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (18)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md (1)
16-16: Tighten wording in Scope; avoid colloquial “diff”, fix spacing.Replace “diff” with “different” and make the sentence flow. There’s also a missing space after the last pipe.
-4 | [Documenting how different protocols work with AsyncAPI](https://github.com/orgs/asyncapi/discussions/533) | Documentation | [Quetzalli Writes](https://github.com/quetzalliwrites) |Community uses diff protocols, because everyone has diverse needs. To get more tutorials with different protocol setups. +4 | [Documenting how different protocols work with AsyncAPI](https://github.com/orgs/asyncapi/discussions/533) | Documentation | [Quetzalli Writes](https://github.com/quetzalliwrites) | Community members use different protocols to meet diverse needs; this initiative will produce tutorials covering various protocol setups.markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (1)
75-75: Align WORKING_GROUPS link style with the rest of the docs.Other pages use a reference-style link to the YAML; mirror that for consistency and easier maintenance.
-- [Working Groups](https://github.com/asyncapi/community/blob/master/WORKING_GROUPS.yaml) - Bami +- [Working Groups][working-groups-yaml] - BamiAdd (or reuse) this reference at the bottom of the file:
[working-groups-yaml]: https://github.com/asyncapi/community/blob/master/WORKING_GROUPS.yamlmarkdown/docs/community/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md (1)
91-91: Polish sentence and fix double space; standardize “Code of Conduct” casing.Minor readability tweak only.
-- Join [our Slack workspace](https://www.asyncapi.com/slack-invite). Observe our [Slack etiquette](../060-meetings-and-communication/slack-etiquette) and [AsyncAPI code of conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). +- Join [our Slack workspace](https://www.asyncapi.com/slack-invite) and observe our [Slack etiquette](../060-meetings-and-communication/slack-etiquette) and [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).markdown/docs/community/011-styleguide/version-control.md (1)
98-98: Replace comma splice with a question mark-Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow). +Need more assistance with contributing to documentation? Check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow).markdown/docs/community/050-mentorship-program/seasonofdocs-2022-README.md (1)
14-14: Unify GitHub handle display style.Use the same “@handle” style used for the next maintainer line.
-- Quetzalli Writes ([quetzalliwrites](https://github.com/quetzalliwrites)): https://twitter.com/QuetzalliWrites +- Quetzalli Writes ([@quetzalliwrites](https://github.com/quetzalliwrites)): https://twitter.com/QuetzalliWritesmarkdown/docs/community/050-mentorship-program/asyncapi-mentorship-README.md (1)
15-15: Update 2024 status to Completed
The mentorship cycle from September 2024 to January 2025 has concluded; change “In Progress” to “Completed.”-| 2024 | Sept-Jan | In Progress | | [Sept-Jan](asyncapi-mentorship-2024-README) | +| 2024 | Sept-Jan | Completed | | [Sept-Jan](asyncapi-mentorship-2024-README) |markdown/docs/community/011-styleguide/index.md (1)
10-10: Prefer internal docs link over GitHub blob for consistency.
Link to the on-site contribution guidelines to avoid cross-repo drift and keep users within the docs. Keep the blockquote only if intentionally emphasized.- > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md). + > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../010-contribution-guidelines).markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
121-121: Simplify relative path.
From this file’s location, a local relative link is sufficient and less brittle.-2. Commit changes with clear messages. Use the [Conventional Commits](../010-contribution-guidelines/conventional-commits) format. +2. Commit changes with clear messages. Use the [Conventional Commits](./conventional-commits) format.markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.md (1)
11-11: Tighten relative link; align naming with doc title.From this file’s directory, the shortest correct path is
./conventional-commits. Also consider capitalizing “Conventional Commits” to match the page title.-- Use the [conventional commit style](../010-contribution-guidelines/conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title. +- Use the [Conventional Commits](./conventional-commits) style when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.markdown/docs/community/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md (1)
73-73: Fix stray double space after period.Minor readability nit.
-- Join [our Slack workspace](https://www.asyncapi.com/slack-invite). Observe our [Slack etiquette](../060-meetings-and-communication/slack-etiquette) and [AsyncAPI code of conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). +- Join [our Slack workspace](https://www.asyncapi.com/slack-invite). Observe our [Slack etiquette](../060-meetings-and-communication/slack-etiquette) and [AsyncAPI code of conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).markdown/docs/community/050-mentorship-program/asyncapi-mentoring-initiatives.md (1)
25-30: Normalize relative link style in “Details” column.Use leading
./consistently for local links.-| [AsyncAPI Mentorship](https://www.asyncapi.com/) | Mentoring initiative by AsyncAPI | [asyncapi-mentorship](./asyncapi-mentorship-README) | -| [Google Summer of Code](https://summerofcode.withgoogle.com/) | Mentoring program for the students | [summerofcode](./summerofcode-README) | -| [Google Season of Docs](https://developers.google.com/season-of-docs) | Mentoring initiative for technical writers | [seasonofdocs](./seasonofdocs-2023-README) | -| [Winter of Code](https://www.winterofcode.com) | Mentoring initiative aimed to increase participation for the Google Summer of Code program among students | [winterofcode](./winterofcode-2023-README) | -| [OpenForce](https://www.openforce.tech/) | The CROSS Research Experiences program provides support for undergraduate and graduate students contributing to CROSS incubator projects. | [openforce](openforce/README) | -| [Hacktoberfest](https://hacktoberfest.com/) | The idea of Hacktoberfest is to encourage everyone, especially beginners, to contribute to projects that are dear to their hearts. | [hacktoberfest](hacktoberfest/README) | +| [AsyncAPI Mentorship](https://www.asyncapi.com/) | Mentoring initiative by AsyncAPI | [asyncapi-mentorship](./asyncapi-mentorship-README) | +| [Google Summer of Code](https://summerofcode.withgoogle.com/) | Mentoring program for the students | [summerofcode](./summerofcode-README) | +| [Google Season of Docs](https://developers.google.com/season-of-docs) | Mentoring initiative for technical writers | [seasonofdocs](./seasonofdocs-2023-README) | +| [Winter of Code](https://www.winterofcode.com) | Mentoring initiative aimed to increase participation for the Google Summer of Code program among students | [winterofcode](./winterofcode-2023-README) | +| [OpenForce](https://www.openforce.tech/) | The CROSS Research Experiences program provides support for undergraduate and graduate students contributing to CROSS incubator projects. | [openforce](./openforce/README) | +| [Hacktoberfest](https://hacktoberfest.com/) | The idea of Hacktoberfest is to encourage everyone, especially beginners, to contribute to projects that are dear to their hearts. | [hacktoberfest](./hacktoberfest/README) |markdown/docs/community/011-styleguide/styling.md (1)
135-137: Prefer trailing slash for directory target to avoid renderer ambiguity.Linking to the directory index explicitly is a touch safer across static site configs.
-- **✅ Good:** See our [Contribution Guide](../010-contribution-guidelines) for more. +- **✅ Good:** See our [Contribution Guide](../010-contribution-guidelines/) for more. -- **❌ Bad:** For more info, [click here](../010-contribution-guidelines). +- **❌ Bad:** For more info, [click here](../010-contribution-guidelines/).markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
168-168: Verify GitHub blob paths; ensure they exist.The workflow path under
.github/workflowslooks right. Please confirm the second path actually lives under.github/workflows/create-event-helpers/issues_templates/…in asyncapi/community; if not, adjust to the real location to avoid a 404.markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
29-29: Simplify the relative path to conventional commitsThe file is in the same directory; the
../010-contribution-guidelines/prefix is redundant and brittle.Apply:
-Make sure to use the [conventional commit style](../010-contribution-guidelines/conventional-commits) while creating PRs and follow these steps: +Make sure to use the [conventional commit style](conventional-commits) while creating PRs and follow these steps:markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (1)
27-27: Align link text with extensionless targetThe visible text still shows
.md. For consistency with the target and project-wide convention, drop.mdfrom the anchor text.-It is recommended that the Working Group schedules meetings using the methods described at [MEETINGS_ORGANIZATION.md](../060-meetings-and-communication/MEETINGS_ORGANIZATION). +It is recommended that the Working Group schedules meetings using the methods described at [MEETINGS_ORGANIZATION](../060-meetings-and-communication/MEETINGS_ORGANIZATION).markdown/docs/community/020-governance-and-policies/GOVERNANCE.md (1)
8-8: Grammar nit + consistencyUse “on the AsyncAPI website” instead of “in AsyncAPI Website,” and prefer lowercase “website.”
-... We also transparently list all the GB members in [AsyncAPI Website](https://asyncapi.com/community/board) +... We also transparently list all GB members on the [AsyncAPI website](https://asyncapi.com/community/board)markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
31-31: Tighten the relative link to conventional commitsSame-dir target; drop the redundant path prefix.
-3. Write an appropriate PR title using the [conventional commits specification](../010-contribution-guidelines/conventional-commits) +3. Write an appropriate PR title using the [conventional commits specification](conventional-commits)markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
101-101: Tighten wording for option 3 and align intro phrase.“Supporting and committing to existing projects…” reads awkwardly, and the list has three items but the intro says “either.” Recommend:
-You can become a maintainer by either: +You can become a maintainer by one of the following: @@ -3. Supporting and committing to existing projects and being invited by other maintainers to join them as a maintainer. For more information, refer to [Become a maintainer in an existing project](../010-contribution-guidelines/Become-maintainer-in-existing-project). +3. Contributing to existing projects and being invited by other maintainers to join them as a maintainer. For more information, refer to [Become a maintainer in an existing project](../010-contribution-guidelines/Become-maintainer-in-existing-project).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (32)
markdown/docs/community/000-onboarding/ambassador-guide.md(1 hunks)markdown/docs/community/000-onboarding/docs-onboarding-checklist.md(1 hunks)markdown/docs/community/000-onboarding/maintainer-guide.md(1 hunks)markdown/docs/community/000-onboarding/upholding-code-of-conduct.md(2 hunks)markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md(2 hunks)markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribution-flow.md(3 hunks)markdown/docs/community/010-contribution-guidelines/git-workflow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md(1 hunks)markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.md(1 hunks)markdown/docs/community/010-contribution-guidelines/tools-and-setup.md(1 hunks)markdown/docs/community/011-styleguide/index.md(1 hunks)markdown/docs/community/011-styleguide/styling.md(1 hunks)markdown/docs/community/011-styleguide/version-control.md(1 hunks)markdown/docs/community/020-governance-and-policies/GOVERNANCE.md(3 hunks)markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md(3 hunks)markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md(1 hunks)markdown/docs/community/020-governance-and-policies/voting.md(2 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentoring-initiatives.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2024-README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship-README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs-2022-README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode-README.md(1 hunks)markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)markdown/docs/community/060-meetings-and-communication/docs-community.md(1 hunks)markdown/docs/community/070-marketing/webinar_series_initiative.md(1 hunks)markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-02-18T12:07:42.211Z
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Applied to files:
markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.mdmarkdown/docs/community/010-contribution-guidelines/code-contributor-guide.md
🪛 LanguageTool
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md
[grammar] ~28-~28: There might be a mistake here.
Context: ...llowing steps to open your pull request: 1. Configure a fork 2. Work on it locally ...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...github.com/asyncapi/community/pull/277).
(QB_NEW_EN)
markdown/docs/community/000-onboarding/ambassador-guide.md
[grammar] ~41-~41: There might be a mistake here.
Context: ...l resources AsyncAPI Ambassador Program
(QB_NEW_EN)
markdown/docs/community/011-styleguide/version-control.md
[grammar] ~98-~98: There might be a mistake here.
Context: ...tribution-guidelines/contribution-flow).
(QB_NEW_EN)
markdown/docs/community/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
[grammar] ~91-~91: There might be a mistake here.
Context: ....github/blob/master/CODE_OF_CONDUCT.md). - Join the dedicated Mentorship channel `#...
(QB_NEW_EN)
markdown/docs/community/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md
[grammar] ~73-~73: There might be a mistake here.
Context: ....github/blob/master/CODE_OF_CONDUCT.md). - Join the dedicated Mentorship channel `#...
(QB_NEW_EN)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship-README.md
[grammar] ~15-~15: There might be a mistake here.
Context: ...-Jan](asyncapi-mentorship-2024-README) | | 2024 | Sep-Mar | In Progress | ...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...Term | Status | Announcement | Details | | ---- | ---- | ------ | ------------ | ...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...---- | ------ | ------------ | ------- | | 2023 | Jan-Nov | Completed | |...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...-Nov](asyncapi-mentorship-2023-README) | | 2022 | Jan-Nov | Completed | |...
(QB_NEW_EN)
markdown/docs/community/050-mentorship-program/seasonofdocs-2022-README.md
[grammar] ~14-~14: There might be a mistake here.
Context: ...s)): https://twitter.com/QuetzalliWrites - Lukasz Gornicki ([@derberg](https://gith...
(QB_NEW_EN)
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md
[grammar] ~39-~39: There might be a mistake here.
Context: ...g-developer-experience`. > [!IMPORTANT] > Please note that the Working Group mem...
(QB_NEW_EN)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[grammar] ~99-~99: There might be a mistake here.
Context: ... or project and becoming its maintainer. 2. Donating to an existing repository or pr...
(QB_NEW_EN)
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md
[grammar] ~21-~21: There might be a mistake here.
Context: ...configured. ## Contribution Etiquette 1. Follow the [Code of Conduct](https://git...
(QB_NEW_EN)
markdown/docs/community/050-mentorship-program/asyncapi-mentoring-initiatives.md
[grammar] ~29-~29: There might be a mistake here.
Context: ...jects. | openforce | | [Hacktoberfest](https://hacktoberfest....
(QB_NEW_EN)
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md
[style] ~33-~33: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...manent action shall require approval of a majority of non-conflicted members of the CoC Commi...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~33-~33: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...ee may take action without a meeting if a majority of non-conflicted members express agreemen...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~33-~33: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... quorum of the non-conflicted members. A majority of non-conflicted members shall be deemed ...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
markdown/docs/community/010-contribution-guidelines/contribution-flow.md
[grammar] ~21-~21: There might be a mistake here.
Context: ...g contributor guide](../000-onboarding). - If you are contributing to the community...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ... the git workflow guide. 2. Search for [good first issues](https://g...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ... even if you created the issue yourself. 6. Follow the [conventional commits guide](...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (33)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md (1)
16-16: Name consistency verified. ‘Quetzalli Writes’ and the [quetzalliwrites] handle are used consistently across all 2023 mentorship docs.markdown/docs/community/000-onboarding/ambassador-guide.md (1)
41-41: No changes needed; casing is correct
The filemarkdown/docs/community/020-governance-and-policies/AMBASSADOR_PROGRAM.mdexists with matching uppercase path, so the link will resolve correctly on case-sensitive builds.markdown/docs/community/070-marketing/webinar_series_initiative.md (1)
86-86: Match link text to document title casing
If the document’s title reads “Webinar Planning Template,” update the link text to[Webinar Planning Template](webinar_planning_template)for consistency.markdown/docs/community/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md (1)
91-93: Slack etiquette link verified The fileslack-etiquette.mdexists inmarkdown/docs/community/060-meetings-and-communication/, so the relative link resolves correctly.markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2024-README.md (1)
23-23: Verify display name vs GitHub handle.“Anthony” links to github.com/bandantonio. Please confirm that “Anthony” is the intended display name for this handle.
Also applies to: 26-26
markdown/docs/community/050-mentorship-program/asyncapi-mentorship-README.md (1)
21-22: Extensionless links consistency check.Both entries properly drop “.md”. Suggest running the link existence check above.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
12-12: Extensionless links validated; trailing whitespace removed
All extensionless link targets resolve to.mdor/index.md. Removed trailing space after the closing parenthesis on line 12 (also applied to lines 15–17 and 19).markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1)
29-29: No action needed: anchor exists
The “Conflicts of Interest” heading at line 204 in COC-incident-resolution-procedures.md generates the correct#conflicts-of-interestanchor.markdown/docs/community/000-onboarding/upholding-code-of-conduct.md (1)
47-47: Link normalization verified
All extensionless slug links (../CODE_OF_CONDUCT_COMMITTEE,../COC-incident-resolution-procedures,../060-meetings-and-communication/slack-etiquette) correctly resolve to their respective markdown files.markdown/docs/community/020-governance-and-policies/voting.md (1)
8-8: All governance links verified
CHARTER.md includes a “### 5. TSC Voting” heading (anchor5-tsc-voting), andTSC_VOTING_OVERVIEW.mdexists atmarkdown/docs/community/020-governance-and-policies/. No changes needed.markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md (1)
76-76: Approve updated “git workflow” link
Target filemarkdown/docs/community/010-contribution-guidelines/git-workflow.mdexists; link is valid.markdown/docs/community/000-onboarding/maintainer-guide.md (1)
49-49: LGTM on extensionless internal link.
The relative path looks correct from this location.markdown/docs/community/010-contribution-guidelines/tools-and-setup.md (1)
23-23: LGTM on link normalization.
The extensionless link aligns with the rest of the PR.markdown/docs/community/060-meetings-and-communication/docs-community.md (1)
6-6: LGTM on extensionless internal linkThe move to an extensionless target aligns with the site’s linking pattern. No issues.
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (2)
16-16: Good switch to extensionless slugLinking to
git-workflowwithout.mdmatches the convention used elsewhere.
23-23: Confirm canonical CONTRIBUTING targetIf the community repo is the intended single source of truth for CONTRIBUTING, this absolute link is correct. If some projects still rely on
.github/CONTRIBUTING.md, consider clarifying which one contributors should follow.markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (2)
42-42: Nice: centralizing the YAML URL via a reference anchorKeeps bullets clean and avoids duplication.
35-37: No changes needed: referenced YAML fields match WORKING_GROUPS.yaml—slack.group.handle,github_team, andslack.channel.handleall exist and are correctly named.markdown/docs/community/020-governance-and-policies/GOVERNANCE.md (4)
49-49: CHARTER link normalization looks goodConsistent with extensionless internal links.
57-57: Second CHARTER reference also correctMatches the new convention.
68-68: Absolute YAML links for TSC membership: goodClearer for readers and less prone to 404s.
74-74: Voting doc link normalizationGood move to extensionless slug.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (2)
26-26: LGTM on extensionless git-workflow linkMatches directory structure and convention.
48-48: Unify TSC membership source-of-truth
The contribution guide directs PRs to updateTSC_BOARD_MEMBERS.yaml, but GOVERNANCE (line 68) states the authoritativeisTSCMemberflag resides inMAINTAINERS.yaml/AMBASSADORS_MEMBERS.yaml. Choose one of:
- Option A: Instruct contributors to set their
isTSCMemberflag in those files & remove all references toTSC_BOARD_MEMBERS.yaml.- Option B: Treat
TSC_BOARD_MEMBERS.yamlas a generated list only and explicitly document thatisTSCMemberis the canonical source.
Confirm the intended canonical source and update this doc accordingly.markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (4)
103-103: Good switch to absolute MAINTAINERS.yaml.GitHub URL prevents local path drift; no issues spotted.
43-43: Anchor slug verified; no changes required.
115-115: Slack etiquette document path validated The filemarkdown/docs/community/060-meetings-and-communication/slack-etiquette.mdexists.
93-93: WORKING_GROUPS link verified: the file WORKING_GROUPS.md resides alongside TSC_MEMBERSHIP.md with matching casing; no change needed.markdown/docs/community/010-contribution-guidelines/contribution-flow.md (5)
34-35: Approve internalized links: Bothconventional-commits.mdandgit-workflow.mdexist undermarkdown/docs/community/010-contribution-guidelines, so the inline links will resolve correctly.
49-49: Slack etiquette link path is correct. Filemarkdown/docs/community/060-meetings-and-communication/slack-etiquette.mdexists at the referenced relative path.
21-23: Link targets verified Onboarding index (markdown/docs/community/000-onboarding/index.md) and docs onboarding checklist (markdown/docs/community/000-onboarding/docs-onboarding-checklist.md) exist.
76-76: Style guide link verified. The directorymarkdown/docs/community/011-styleguide/contains anindex.md, so the relative link will route correctly.
28-28:git-workflowlink target verified — file exists with matching slug.
| | 2 | [Website UI Kit design/dev project](https://github.com/asyncapi/design-system/issues/4) | [AceTheCreator](https://github.com/AceTheCreator) | Design | [AISHAT MUIBUDEEN](https://github.com/Mayaleeeee) | | ||
| | 3 | [MVP integration of extensions catalog with AsyncAPI tools](https://github.com/asyncapi/extensions-catalog/issues/78) | [Lukasz Gornicki](https://github.com/derberg) | Engineering | [Sambhav Gupta](https://github.com/sambhavgupta0705) | | ||
| | 4 | [Documenting how different protocols work with AsyncAPI](https://github.com/orgs/asyncapi/discussions/533) | [Alejandra Quetzalli](https://github.com/alequetzalli) | Documentation | [Cynthia Peter](https://github.com/CynthiaPeter), [Arya Gupta](https://github.com/Arya-Gupta), [Joy Almeida](https://github.com/J0SAL), [Vaishnavi Nandakumar](https://github.com/VaishnaviNandakumar)| | ||
| | 4 | [Documenting how different protocols work with AsyncAPI](https://github.com/orgs/asyncapi/discussions/533) | [Quetzalli Writes](https://github.com/quetzalliwrites) | Documentation | [Cynthia Peter](https://github.com/CynthiaPeter), [Arya Gupta](https://github.com/Arya-Gupta), [Joy Almeida](https://github.com/J0SAL), [Vaishnavi Nandakumar](https://github.com/VaishnaviNandakumar)| |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Mentor rename looks correct; ensure no stale references remain.
Change reads well; please confirm there are no lingering “Alejandra Quetzalli/alequetzalli” mentions elsewhere.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n --ignore-case 'alejandra\s+quetzalli|alequetzalli' markdown/ || trueLength of output: 201
Update stale mentor reference in CODE_OF_CONDUCT_COMMITTEE.md
At markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md:26, rename “Alejandra Quetzalli” to “Quetzalli Writes”.
🤖 Prompt for AI Agents
In
markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-README.md
around line 22 and specifically in
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md at line 26, update the
stale mentor reference: replace the display text “[Alejandra
Quetzalli](https://github.com/alequetzalli)” with “[Quetzalli
Writes](https://github.com/quetzalliwrites)”. Ensure both the visible name and
the linked GitHub username/URL are changed to the new handle, save the file, and
run any link checks or linters before committing.
|
|
||
| - **Write your project proposal.** | ||
| Visit the [ideas page](./summerofcode-2024-asyncapi-gsoc-ideas-page.md) to choose a topic that catches your interest. You can also draw inspiration from projects from previous years. | ||
| Visit the [ideas page](./summerofcode-2024-asyncapi-gsoc-ideas-page) to choose a topic that catches your interest. You can also draw inspiration from projects from previous years. |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify target and consider year-agnostic link.
The extensionless link is fine, but please confirm the target file exists and whether a 2025 (or generic) ideas page should be referenced to avoid dating this page.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Verify ideas page target exists and check for newer variants
t='markdown/docs/community/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md'
[ -f "$t" ] && echo "OK: $t" || echo "MISSING: $t"
echo "Potential ideas pages:"
fd -a --glob 'summerofcode*ideas*' markdown | sed -n '1,200p'Length of output: 766
Update ideas page link to 2025 variant
Replace in markdown/docs/community/050-mentorship-program/summerofcode-README.md (line 34) the link target
- [ideas page](./summerofcode-2024-asyncapi-gsoc-ideas-page)
+ [ideas page](./summerofcode-2025-asyncapi-gsoc-ideas-page)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Visit the [ideas page](./summerofcode-2024-asyncapi-gsoc-ideas-page) to choose a topic that catches your interest. You can also draw inspiration from projects from previous years. | |
| Visit the [ideas page](./summerofcode-2025-asyncapi-gsoc-ideas-page) to choose a topic that catches your interest. You can also draw inspiration from projects from previous years. |
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/summerofcode-README.md around
line 34, the ideas page link points to the 2024 file; update the link target to
the 2025 variant (replace ./summerofcode-2024-asyncapi-gsoc-ideas-page with
./summerofcode-2025-asyncapi-gsoc-ideas-page) so the anchor directs to the 2025
ideas page.
| ## Incident Resolution Procedures | ||
|
|
||
| Please see our [Incident Resolution Procedures](./COC-incident-resolution-procedures.md), which address, among others: | ||
| Please see our [Incident Resolution Procedures](COC-incident-resolution-procedures), which address, among others: |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
New reference list: sanity-check referenced sections exist in procedures
Quickly verify the referenced topics exist (as headings or list items) in the procedures doc.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
proc_path="$(fd -a -i 'COC-incident-resolution-procedures.md' markdown/docs/community || fd -a -i 'COC-incident-resolution-procedures/index.md' markdown/docs/community)"
echo "Scanning: $proc_path"
for p in \
"How to submit a report" \
"What information to share in your report" \
"What happens after a report is submitted" \
"Resolution" \
"Information sharing" \
"Confidentiality Policy" \
"No retaliation" \
"Conflicts of interest"
do
if rg -n -i --fixed-strings "$p" "$proc_path" >/dev/null; then
echo "OK: '$p'"
else
echo "CHECK: '$p' not found literally — confirm phrasing/anchors."
fi
doneLength of output: 3945
🏁 Script executed:
#!/bin/bash
set -euo pipefail
proc_path="markdown/docs/community/COC-incident-resolution-procedures.md"
echo "Scanning headings in: $proc_path"
rg -n '^#{1,3} ' "$proc_path"Length of output: 1505
Fix list item wording to match procedures doc heading Change “What information to share in your report” to “What information to include in your report” in markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md:41
🤖 Prompt for AI Agents
In markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md around line 41, the list
item uses the phrase “What information to share in your report”; update that
wording to exactly “What information to include in your report” so it matches
the heading in the procedures doc — locate the text on line 41 and replace the
phrase accordingly, preserving surrounding punctuation and link formatting.
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit