-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs(community): update latest community documentation #4248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(community): update latest community documentation #4248
Conversation
❌ Deploy Preview for asyncapi-website failed.
|
WalkthroughThis update introduces a large set of new and revised community documentation files for AsyncAPI, including onboarding guides, contribution guidelines, governance policies, mentorship programs, working group procedures, meeting organization, and marketing strategies. It also updates configuration to reference these new documents, corrects some existing links and formatting, and adds several placeholder files for future content. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Documentation
participant Maintainer
participant Community
participant Governance
Contributor->>Documentation: Reads onboarding/contribution guides
Contributor->>Community: Joins mentorship, meetings, or working groups
Contributor->>Maintainer: Submits PRs, follows Git workflow
Maintainer->>Governance: Applies policies (CoC, voting, funding)
Maintainer->>Contributor: Reviews, recognizes, mentors
Governance->>Community: Publishes charters, policies, goals, and marketing
Community->>Documentation: Updates/expands guides, policies, and resources
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:
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
Documentation and Community
|
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 #4248 +/- ##
=========================================
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:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 18
🔭 Outside diff range comments (1)
config/edit-page-config.json (1)
15-17: New community mappings will never match – shadowed by the blank fallback
determineEditLink()returns the first item whosevalueis contained in the page path.
The blanket fallback entry ("value": "") is on lines 15-17 and therefore evaluated before all newly-appended community rules (lines 31-65).
Result: every community page will match the blank entry first, so the specific GitHub URLs you just added are unreachable.Re-order: move the empty-string rule to the very end (or delete it if another final catch-all exists).
This is functional, not cosmetic—without it the edit-link points towebsite/markdowninstead of the community repo.Also applies to: 31-65
🧹 Nitpick comments (98)
markdown/docs/community/community-glossary.md (1)
1-3: Add front-matter headers so the page renders correctlyThe new glossary placeholder lacks the front-matter block (
---,title,description,weight) that Hugo-based pages elsewhere rely on. Without it, the build pipeline may skip or mis-index the page.Please add the standard front-matter even if the body is “under construction”.
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (2)
63-67: Replace hard tabs with spaces in the Markdown table
markdownlintflags MD010 (“no-hard-tabs”). Tabs can break table rendering in some markdown engines and cause lint failures. Convert the tab characters to single spaces to keep column alignment consistent.
125-126: Typo: “Moreoever” → “Moreover”Minor spelling error in the narrative text; consider correcting to avoid distraction in published docs.
markdown/docs/community/070-marketing/social-media-communication-guidelines.md (1)
1-3: Add front-matter and minimal outlineUnlike the other community docs, this file lacks YAML front-matter (
title,weight, …). Without it, the build treats the page as raw content, which may break navigation, ordering and edit-link generation.
Consider adding the usual front-matter block plus at least a bullet-point skeleton (audience, tone, do/don’t) so contributors know where to extend the draft.markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (2)
2-2: Minor typos• “annoucement” → “announcement”
Keeping docs typo-free improves credibility, especially in public program pages.
11-14: Ordinal suffix typo“23th January” should be “23rd January”.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (2)
14-15: Header-separator has a trailing space – breaks Markdown table parsingThe delimiter row should have exactly the same number of columns as the header and no stray spaces.
Current:---|---|---|---|--- | ---
Expected:---|---|---|---|---|---The extra space after the fifth dashes makes some Markdown renderers treat the last two cells as one.
21-21: Raw URL inside table violates MD034 and hurts readability
https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788is rendered as bare text.
Wrap it in link syntax to stay consistent with the rest of the column and silence markdown-lint:
[discussion comment](https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md (1)
11-13: Missing blank line before the table – triggers MD058Add an empty line between the paragraph and the table header so that all renderers recognise the table correctly.
Mentorship duration - Six months (full-time schedule) | No | Project Idea | …markdown/docs/community/050-mentorship-program/README.md (1)
24-25: Program table rows are missing trailing pipesRows for OpenForce and Hacktoberfest don’t end with
|, so some linters flag MD055 and the table may mis-align.
Ensure every row has the same opening and closing pipes:
| [Hacktoberfest](https://hacktoberfest.com/) | … | [hacktoberfest](hacktoberfest/README.md) |markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
31-32: Screenshot needs descriptive alt text for accessibility
gives no context to screen-reader users.
Replace with something like:
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (1)
3-3: Bare URL – wrap in Markdown link for consistencyChange
Be sure to read https://google.github.io/gsocguides/student/writing-a-proposal
to
Be sure to read [Google’s guide to writing a proposal](https://google.github.io/gsocguides/student/writing-a-proposal)
to keep formatting uniform and satisfy MD034.markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (2)
21-24: Replace hard tabs with spaces to satisfy MD010 and maintain consistent indentationThe bullets under “Timeline” currently contain literal tab characters, which markdownlint flags (
MD010/no-hard-tabs). Converting these to two-space indents keeps the list readable and quiets the linter.
40-41: Wrap the bare URL in Markdown link syntaxLine 41 shows a naked link; markdownlint (
MD034) prefers[link text](url)or<url>. Consider wrapping it to keep documentation styling consistent.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (2)
9-10: Minor wording / spacing tweak“12 to 18weeks” is missing a space before “weeks”. Recommend “12 to 18 weeks”.
11-14: Insert a blank line before the table to satisfy MD058Markdown tables should be surrounded by blank lines. Add one after the “Accepted projects” heading to avoid a markdownlint warning and render the table reliably in all engines.
markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
47-49: Wrap bare email/URL references for consistencyLine 47 contains a bare email & URL. Wrapping the address in markdown (
<conduct@asyncapi.io>or[conduct@asyncapi.io](mailto:conduct@asyncapi.io)) and the committee link in standard link syntax avoidsMD034warnings and aligns with the rest of the doc.markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (3)
27-40: Table is missing trailing pipes → breaks GitHub rendering
markdownlint(MD055) is right: each row in the Emoji/Type table should end with a|.
Without the trailing pipes the table does not render consistently across viewers.
Add the pipes to every row to keep formatting predictable.
43-44: Inconsistent unordered-list markerAll other lists in the doc use
-, but these two items use*.
For visual consistency switch to a single bullet style throughout.
7-16: Minor wording / grammar polishA few quick wins:
• Line 9 – “Answer to questions” → “Answer questions”
• Line 15 – “many different ways” → “various ways”Not blocking, but tightening phrasing improves readability.
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
58-65: Typo: “Maintainance” → “Maintenance”The section header and slug both contain the misspelling.
Search-replace to avoid looking unpolished in an external-facing document.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (3)
1-4: Heading & title tweaks• Line 1 – plural: “Project ideas”, not “Projects ideas”.
• Line 4 –### Ideas listskips a level after#; use##to satisfy MD001.
24-25: Spelling: “Fuction-as-a-Service” & “prodution-ready”These small typos undermine credibility—worth fixing before publishing.
17-17: Confidence wordingPhrase “I think we should” can be shortened to “We should” for a firmer call to action.
Pure copy-editing; ignore if the softer tone is intentional.markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (2)
3-8: Heading levels jump (MD001)After
# GSoC Mentor's Guideline, the next heading should be## Introduction, not#####.
Adjusting keeps the document hierarchy logical and helps automatic TOC tools.
7-15: Paragraph lengthLines 11-15 bundle several independent duties into one long bullet.
Splitting into separate bullets (guidance, comms, reviews, documentation) makes scanning easier for busy mentors.markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (2)
11-11: Use real headings instead of bold italicsMarkdownlint flags the bold “Step X” lines (MD036).
Converting them to## Step 1,## Step 2, … yields:
• Better TOC generation
• Consistent hierarchy (no skip after the initial###)
1-2: Top-level headingConsider making the very first line an
# H1to align with the rest of the community docs.
Currently it starts at###, which hampers TOC structure.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (6)
1-1: Headline grammar – change “Projects ideas” to “Project ideas”.
Minor wording tweak makes the heading grammatically correct and matches singular/plural usage elsewhere.
6-7: Surround the table with blank lines.
Markdown-lint (MD058) flags missing blank lines immediately before and after the table header; adding them improves readability and silences the linter.
11-11: Clarify wording and avoid slang.
“Community uses diff protocols…” → “The community uses different protocols…” reads clearer and avoids the informal abbreviation “diff”.
12-12: Fix typo “engile”.
In the Node.js template row, “React templating engile” → “React templating engine”.
14-14: Insert missing space and polish sentence.
“…can make)and how to deploy Glee.” → “…can make) and how to deploy Glee.”
27-27: Consistent terminology – pick one spelling.
Both “visualiser” (British) and “visualizer” (US) appear; choose one for consistency across the docs (the repo mostly uses “visualizer”).markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (6)
2-2: Top-level heading should start with#.
Most docs in this folder begin with an H1; changing## How spec changes are introducedto# How spec changes are introducedkeeps hierarchy consistent.
3-3: Tighten wording.
“…concentrates on the problems rather than the solution.” → “…concentrates on problems rather than solutions.”
6-6: Comma splice.
Break the sentence after “substantial” or replace the comma with a period:
Some changes, however, are "substantial." We ask …
16-17: Subject-verb agreement.
“…lifecycle consist of 2 parts” → “…lifecycle consists of two parts…”.
23-23: Plural-singular mismatch.
“The contributors/maintainers reviews” → “Contributors/maintainers review”.
65-65: Typo “preperation”.
Line reads “…proposal acceptance and preperation…” → “…preparation…”.markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (2)
5-5: Missing comma in introductory sentence.
“…Committee (CoC Committee) is a committee that responds to investigates, and resolves…” → “…responds to, investigates, and resolves…”.
28-28: Very long paragraph – consider splitting.
The decision-making block is 500+ characters; breaking it into shorter paragraphs or bullet points improves readability without changing policy semantics.markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (1)
18-20: Indentation & bare-URL issues in nested list.
Markdown-lint flags (MD007, MD034) are triggered because the image-handling sub-list is indented with three spaces and contains a bare URL.
– Indent with two spaces to match surrounding bullet style.
– Wrap the URL in angle brackets or markdown link syntax to avoid bare-URL lint errors.markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (1)
32-32: Code formatting note.
Sentence says “Use backticks () for code” but the emptypair renders nothing. Use a visible example like`code`so newcomers immediately see how it looks.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (2)
13-14: Minor formatting glitches in row 7
EDAVisualiser's[EDAVisualiser]is missing a space and renders the Markdown link incorrectly. Also consider shortening the very long cell text to keep the table readable.
22-24: Hard tab characters trigger MD010 lint errorsTwo rows contain literal tab characters, which violate the repo’s markdown-lint rules. Replace tabs with spaces to avoid CI noise.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (2)
93-100: Branch name hard-coded tomasterSeveral AsyncAPI repos already default to
main. Hard-codingmastermay mislead newcomers. Suggest rephrasing as “default branch (master/mainas appropriate)” or link to the repo’s default branch dynamically.
115-118: Out-of-date Conventional Commits linkThe link points to a closed PR (
community/pull/1733). Prefer linking to the canonical Conventional Commits spec or an evergreen AsyncAPI guideline page.markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (2)
45-47: Typos: “requried” → “required”Correct the spelling under Technical skills required for a more professional presentation.
56-59: Spelling: “checkes” → “checks”In the automation-bot description, replace “checkes” with “checks”.
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (2)
37-38: Sentence repetition – readabilityThree consecutive sentences start with “If contributors…”. Consider re-phrasing one of them to avoid monotony and improve flow.
56-63: Bare GitHub API URL inside blockquote triggers MD034Convert the raw API link to Markdown format or wrap it in
<https://…>so markdown-lint passes.markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (2)
33-33: Spelling: “Maintainance” → “Maintenance”Fix the project title in row 7 to avoid a typo on the public webpage.
9-10: Date format inconsistencyMost dates use the numeric day without leading zero (e.g., May 1). “April 02” includes a leading zero; align formatting for consistency (
April 2).markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (3)
12-18: Fix spelling & maintain professional tone
Specifing→Specifying(l 13).
While you’re touching the sentence, consider tightening the wording: “Explain how to use and reuse parameters.”Small polish, but it removes a visible typo.
20-23: Grammar tweaks for clarity“…specify thing that are common only for given protocol.”
Recommend: “specify things that are protocol-specific.”
Minor, yet reads much smoother.
29-31: Remove double space
a learning(two spaces) in l 29. Trim to one.markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (3)
17-19: Capitalize technology names consistently
Javascript/Typescript→JavaScript/TypeScript(l 17–18).
Ensures consistency across the ideas list.
44-45: Hyphenate compound adjective“Open Source Contribution” → “open-source contribution” for correct compound-adjective style.
70-72: Sentence reads awkwardly“Add E2E tests for the website where some of the critical flows (that are centered around user experience are tested thoroughly).”
Proposed: “Add E2E tests that thoroughly cover the website’s user-critical flows.”
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (1)
22-24: Label names should use back-ticks consistentlyYou wrap
good first issueandhelp wantedin back-ticks once (l 22) but not in the numbered list below. Either wrap everywhere or nowhere.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (3)
13-14: Spelling
Specifing→Specifying(l 13).
26-27: Double space
a learning experience(double space) → single space.
54-55: Currency wording“$350 dollars” repeats the currency symbol. Use “$350” or “350 dollars.”
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (2)
73-75: Typo
Progam Administrators→Program Administrators.
118-123: Indented list breaks markdownlint rulesNested bullet lists use 4-space indent but style guide expects 2. Re-indent to silence MD007 and improve readability.
markdown/docs/community/020-governance-and-policies/voting.md (3)
35-38: Fix nested-list indentation (markdownlint MD007).The sub-bullets under point 4 are indented with one extra space, triggering MD005/MD007.
Re-indent them two spaces further than the parent bullet so markdown renders lists correctly.
22-23: Clarify inactivity rule wording.“if you do not participate in voting within three months, you will stop being a TSC member” can be read as immediate and automatic removal.
Spell out that the GB initiates the removal according to Charter §4 to avoid misinterpretation.
24-26: Tighten quorum example math.51 % of 40 = 20.4, rounded up to 21. Spelling this out (“rounded up”) prevents readers thinking fractions count.
markdown/docs/community/COC-incident-resolution-procedures.md (2)
190-193: Style nit – drop “very”.“a very small number of people” → “a small number of people”.
Minor, but improves concision per LanguageTool hint.
232-233: Use “cannot” instead of “can not”.Standardises phrasing and follows LanguageTool guidance.
markdown/docs/community/050-mentorship-program/summerofcode/README.md (2)
3-4: Heading level jumps from H1 to H6 (MD001).
###### Introductionshould be## Introductionto increment by one level and keep the document hierarchy valid.
39-40: Tone – excessive exclamation.The sentence ends with “we are here to help you 😊.” – six exclamation marks in the whole doc already flag LanguageTool. Consider limiting punctuation for a more professional tone.
markdown/docs/community/070-marketing/webinar_series_initiative.md (3)
1-4: Front-matter: makeweightnumeric.Other docs use an integer (
weight: 170). Keeping the value as a number avoids string/number mixing during site generation.
146-148: Remove trailing colon in heading (MD026).
## Disclaimer:→## Disclaimerto satisfy markdownlint.
42-50: Minor style – clarify schedule sentence.“Sessions are held monthly or bi-monthly based on availability of speakers and community demand.”
Consider defining “bi-monthly” (every two months vs twice a month) to avoid ambiguity.markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (3)
23-28: Fix MD055 – remove trailing pipes in the sponsorship-tier tableThe pipe at the end of each row violates the
table-pipe-stylerule and breaks some Markdown renderers’ table detection.Example patch (manually adjust amounts as needed):
-| Tier | Amount | Benefits | -| --- | --- | --- | -| Bronze | $100/month | Company logo in README on GitHub | -| Silver | $500/month | Company logo in README on GitHub and asyncapi.com | -| Gold | $1,000/month | Company logo in README on GitHub and asyncapi.com | -| Platinum | $2,000/month | Company logo in README on GitHub and asyncapi.com. Up to 2 hours of support per month. Support will be remote with the option of a shared screen or via private chat. Support hours do not accumulate. | +| Tier | Amount | Benefits | +| --- | --- | --- | +| Bronze | $100 / month | Company logo in README on GitHub | +| Silver | $500 / month | Company logo in README on GitHub and asyncapi.com | +| Gold | $1 000 / month | Company logo in README on GitHub and asyncapi.com | +| Platinum | $2 000 / month | Company logo in README on GitHub and asyncapi.com. Up to 2 h of remote support per month (screen-share or private chat, non-accumulating). |
40-41: Tighten wording to avoid filler phrases
“on a regular basis”is flagged as wordy. Consider“regularly”:-Assign your employees to contribute to projects under AsyncAPI Initiative on a regular basis, +Assign your employees to contribute regularly to projects under the AsyncAPI Initiative,Minimal change, clearer sentence.
106-108: Convert bare email/URL into Markdown linksLine 108 contains a bare e-mail address; wrap it for consistency:
Write an e-mail to <info@asyncapi.io>.(or
[info@asyncapi.io](mailto:info@asyncapi.io))This removes MD034 warnings and makes the contact action obvious.
markdown/docs/community/020-governance-and-policies/donating-projects.md (1)
17-20: Vary sentence openings to avoid repetitionThree consecutive bullet sentences start with “We” (flagged by LanguageTool). Consider merging or re-phrasing to improve flow, e.g.:
- We value Contributor License Agreements (CLAs) … - Intellectual-property review is essential when …Purely stylistic but increases readability of the legal section.
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (1)
93-98: Correct “Mastadon” → “Mastodon”The social platform name is misspelled in two places. Consistency matters for searchability and professionalism.
Also applies to: 115-116
markdown/docs/community/onboarding-guide/github-actions.md (2)
58-60: Unify unordered-list marker style (MD004)Asterisks are used here while the rest of the doc (and repo conventions) use dashes. Pick one style (preferably
-) to silence MD004 and keep formatting consistent.Also applies to: 70-72
95-103: Replace emphasized labels with proper headingsLines 95 (“Opt-in”) and 101 (“Opt-out”) are flagged by MD036. Changing them to level-three headings improves document structure and sidebar navigation:
-**Opt-in** +### Opt-in(and the same for Opt-out).
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (2)
6-8: Clarify chairperson-duty sentence and tighten wordingThe current phrasing (“facilitate the group meets its goals … works in a transparent manner”) is grammatically off and a bit wordy. Rephrase to something like “facilitate the group’s progress toward its goals, remove blockers, ensure efficiency and alignment with the AsyncAPI roadmap, and run meetings transparently.”
20-21: Sentence is hard to parse“communicate through official channels all relevant discussions and implementations that want to suggest to others” is unclear. Consider splitting into two sentences and specifying what must be communicated and where (e.g. GitHub, Slack, mailing list).
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (3)
16-18: Mixed bullet styles trigger markdown-lintLines 16-18 use asterisks whereas the document elsewhere uses dashes. For consistency (and to silence MD004), switch these to dashes.
47-75: Add alt text for embedded imagesAll images between lines 47-75 (and later sections) lack
altattributes, flagged by MD045. Adding concise alt text improves accessibility and SEO.
168-169: Minor wording“so he can give you access” → “so he can grant you access” reads cleaner and avoids the informal “give”.
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
66-70: Typo: “emojies” → “emojis”Spelling error in the voting section. Correcting avoids distracting readers and improves professionalism.
markdown/docs/community/styleguide/version-control.md (2)
57-60: Double space in heading“### When Submitting Changes” has two consecutive spaces. Small polish item but worth cleaning up.
90-95: Extra spaces inside sentencesThere is a double space before “in existing documentation” (line 94). Quick search-and-replace to remove stray spaces maintains consistent formatting.
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (4)
4-4: Remove trailing colon in heading “Current Challenges”Markdown-lint (MD026) flags trailing punctuation in headings. Dropping the colon keeps headings clean and consistent with surrounding ones.
11-11: Heading punctuation: same issue as aboveThe colon after “Objectives to Address These Challenges” triggers the same MD026 warning. Consider removing it.
16-16: Third heading with trailing punctuation“Proposed Solutions:” also ends with a colon; align with the no-colon convention or suppress the linter rule globally.
31-32: Missing space after period“...we can record and build upon.Once we have some onboarding...” Add a space after the period for readability.
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (3)
26-26: Extraneous spaces inside emphasis markers
** Middle **and** Senior **(MD037) break bold rendering. Remove inner spaces to render correctly as Middle / Senior.
48-52: Bare URLs could be turned into reference linksMultiple raw links (e.g., random.org, repo issues) violate MD034. Converting to Markdown reference links improves readability and future-proofs formatting.
1-254: Document is 250 + lines; consider modularisingAt ~7 kB, this single file mixes policy, process, examples, and templates. Splitting into logically focused sub-docs (budget, timelines, invoicing, suspensions) will ease maintenance and reader navigation.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (62)
config/edit-page-config.json(1 hunks)markdown/docs/community/000-onboarding/docs-onboarding-checklist.md(1 hunks)markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md(1 hunks)markdown/docs/community/000-onboarding/how-to-contribute.md(1 hunks)markdown/docs/community/000-onboarding/where-to-contribute.md(1 hunks)markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md(1 hunks)markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md(1 hunks)markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribution-flow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/git-workflow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognize-contributors.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md(1 hunks)markdown/docs/community/011-styleguide/grammar.md(1 hunks)markdown/docs/community/011-styleguide/numbers.md(1 hunks)markdown/docs/community/020-governance-and-policies/CHARTER.md(1 hunks)markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md(1 hunks)markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md(1 hunks)markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md(1 hunks)markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md(1 hunks)markdown/docs/community/020-governance-and-policies/donating-projects.md(1 hunks)markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md(1 hunks)markdown/docs/community/020-governance-and-policies/voting.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md(1 hunks)markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md(1 hunks)markdown/docs/community/040-guides/keep-repository-settings-consistent.md(1 hunks)markdown/docs/community/050-mentorship-program/README.md(1 hunks)markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.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/2024/project-ideas.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/seasonofdocs/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2024/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/050-mentorship-program/summerofcode/application-template.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md(1 hunks)markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md(1 hunks)markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)markdown/docs/community/060-meetings-and-communication/slack-etiquette.md(1 hunks)markdown/docs/community/070-marketing/social-media-communication-guidelines.md(1 hunks)markdown/docs/community/070-marketing/webinar_planning_template.md(1 hunks)markdown/docs/community/070-marketing/webinar_series_initiative.md(1 hunks)markdown/docs/community/COC-incident-resolution-procedures.md(1 hunks)markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md(1 hunks)markdown/docs/community/community-glossary.md(1 hunks)markdown/docs/community/onboarding-guide/github-actions.md(1 hunks)markdown/docs/community/onboarding-guide/identifying-good-first-issues.md(1 hunks)markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md(1 hunks)markdown/docs/community/styleguide/version-control.md(1 hunks)
🧰 Additional context used
🧠 Learnings (22)
📓 Common learnings
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
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.
Learnt from: TRohit20
PR: asyncapi/website#4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/markdown/check-edit-links.test.js:20-46
Timestamp: 2025-01-14T14:58:38.076Z
Learning: In the AsyncAPI website codebase, the edit-page-config.json contains a fallback match entry that ensures determineEditLink function always has a valid target.value, making null checks unnecessary.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-editlinks.js:58-59
Timestamp: 2025-01-08T15:15:00.759Z
Learning: In the AsyncAPI codebase, batch processing operations (like in the Dashboard script and check-editlinks.js) follow a sequential pattern using await in loops, which is the preferred approach for maintaining consistency across the codebase.
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3301
File: scripts/markdown/check-markdown.js:0-0
Timestamp: 2024-10-18T17:24:45.053Z
Learning: In `scripts/markdown/check-markdown.js`, the script is not run in an asynchronous environment, so refactoring it to use `async/await` is unnecessary.
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
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (3)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
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
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (5)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: asyncapi/website#3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).
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
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
config/edit-page-config.json (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/markdown/check-edit-links.test.js:20-46
Timestamp: 2025-01-14T14:58:38.076Z
Learning: In the AsyncAPI website codebase, the edit-page-config.json contains a fallback match entry that ensures determineEditLink function always has a valid target.value, making null checks unnecessary.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-editlinks.js:80-93
Timestamp: 2025-01-14T09:23:32.728Z
Learning: In the AsyncAPI website's edit link generation system, the `editOptions` array in `edit-page-config.json` includes a fallback entry with an empty string value (`''`) that matches any URL path, ensuring that `determineEditLink()` function always finds a target and never returns null.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-edit-links.js:83-88
Timestamp: 2025-01-14T15:12:29.840Z
Learning: In the AsyncAPI website's edit link generation logic, the `editUrls` configuration (config/edit-page-config.json) includes a fallback entry with an empty value that acts as a catch-all matcher. Therefore, `editOptions.find()` will always return a match, making null checks on the result unnecessary and untestable.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (1)
Learnt from: aminoxix
PR: asyncapi/website#4127
File: components/layout/CommunityLayout.tsx:179-179
Timestamp: 2025-06-10T06:27:25.419Z
Learning: In AsyncAPI's community data structure, ambassadors and TSC members are guaranteed to have GitHub accounts. The `github` field is required in both `Ambassador` and `Tsc` interfaces, and the data processing in `addAdditionalUserInfo()` converts GitHub usernames to full URLs, ensuring safe string operations when extracting usernames from URLs.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
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
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (3)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
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
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (3)
Learnt from: iambami
PR: asyncapi/website#4111
File: markdown/blog/community-spotlight-aayush.md:3-3
Timestamp: 2025-06-03T06:48:09.304Z
Learning: For AsyncAPI community spotlight blog posts, the frontmatter date should reflect the actual publication date, not the month being highlighted in the spotlight. For example, a "May Community Spotlight" can be published in June with a June date in the frontmatter.
Learnt from: Siddhant-Pragyan-Sinha
PR: asyncapi/website#4074
File: markdown/blog/open-nest.md:11-12
Timestamp: 2025-04-28T01:13:59.084Z
Learning: For AsyncAPI blog posts, author photo filenames don't necessarily need to match the author's official name, as some authors may use pen names or nicknames (e.g., Aishat Muibudeen using "maya_picture.webp" for her avatar).
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
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (2)
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
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
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (2)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: TRohit20
PR: asyncapi/website#4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
Learnt from: aminoxix
PR: asyncapi/website#4127
File: components/layout/CommunityLayout.tsx:179-179
Timestamp: 2025-06-10T06:27:25.419Z
Learning: In AsyncAPI's community data structure, ambassadors and TSC members are guaranteed to have GitHub accounts. The `github` field is required in both `Ambassador` and `Tsc` interfaces, and the data processing in `addAdditionalUserInfo()` converts GitHub usernames to full URLs, ensuring safe string operations when extracting usernames from URLs.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (2)
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
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/styleguide/version-control.md (1)
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
markdown/docs/community/onboarding-guide/github-actions.md (5)
Learnt from: akshatnema
PR: asyncapi/website#3168
File: jest.config.js:6-6
Timestamp: 2024-10-15T17:44:59.227Z
Learning: In this repository, the `coverage` directory is added to `.gitignore`, and coverage reports are generated during GitHub Actions runs.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: .github/workflows/check-edit-links.yml:25-29
Timestamp: 2025-01-08T15:16:27.655Z
Learning: In GitHub workflows running scripts with process.exit statements for error handling (like check-editlinks.js in asyncapi/website), avoid adding error suppression (|| true) at the workflow level as it would mask the intended error reporting mechanism.
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
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: .github/workflows/check-edit-links.yml:30-37
Timestamp: 2025-01-14T14:57:08.491Z
Learning: In GitHub Actions workflows, avoid using {...} blocks for output redirection. Instead, use individual redirects with proper quoting as recommended by GitHub Docs. For example:
```yaml
echo "key<<EOF" >> "${GITHUB_OUTPUT}"
echo "${value}" >> "${GITHUB_OUTPUT}"
echo "EOF" >> "${GITHUB_OUTPUT}"
```
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.
Learnt from: akshatnema
PR: asyncapi/website#3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.
Learnt from: akshatnema
PR: asyncapi/website#3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the `tests/fixtures/tools/automated-tools.json` file, the `language` field within the `filters` object can be either a string or an array. Both formats are acceptable and supported in the codebase.
markdown/docs/community/070-marketing/webinar_series_initiative.md (2)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: iambami
PR: asyncapi/website#4111
File: markdown/blog/community-spotlight-aayush.md:3-3
Timestamp: 2025-06-03T06:48:09.304Z
Learning: For AsyncAPI community spotlight blog posts, the frontmatter date should reflect the actual publication date, not the month being highlighted in the spotlight. For example, a "May Community Spotlight" can be published in June with a June date in the frontmatter.
🪛 LanguageTool
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...google.github.io/gsocguides/mentor/) - [Open Source Best Practices](https://opensource.guid...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
[style] ~9-~9: Consider using a synonym to be more concise.
Context: ...//github.com/AceTheCreator) | There are a lot of places where components need to be crea...
(A_LOT_OF)
[style] ~14-~14: To elevate your writing, try using a synonym here.
Context: ...ithub.com/KhudaDad414)|Currently, it is hard to get started with Glee as a new user,...
(HARD_TO)
[style] ~27-~27: Consider using a different adjective in this context to strengthen your wording.
Context: ...t it only works in read-only mode. So a good solution would be to add the ability to...
(GOOD_ALTERNATIVE)
[uncategorized] ~27-~27: Do not mix variants of the same word (‘visualizer’ and ‘visualiser’) within a single text.
Context: ...d, similar to the current blocks in the visualizer. 21 | [Desktop/Native application for A...
(EN_WORD_COHERENCY)
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md
[style] ~37-~37: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...come ambassadors for the whole year. 3. If you were accepted as ambassador on the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~41-~41: ‘in tune with’ might be wordy. Consider a shorter alternative.
Context: ... 2022. ### Ambassadors duties - Be in tune with AsyncAPI's mission and values. - Always...
(EN_WORDINESS_PREMIUM_IN_TUNE_WITH)
[style] ~56-~56: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...he process of becoming an ambassador is very simple. Go to the community repository and...
(EN_WEAK_ADJECTIVE)
markdown/docs/community/050-mentorship-program/README.md
[style] ~3-~3: Consider using a more concise synonym.
Context: ...The AsyncAPI Initiative participates in a variety of mentoring programs. AsyncAPI is a great...
(A_VARIETY_OF)
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md
[uncategorized] ~44-~44: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ensions, Spectral Linting, Testing, and Open Source Contribution. - 🧩 Difficulty: Medi...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~80-~80: Ensure spelling is correct
Context: ...Required:** Typescript, Node js, Figma, TailwindCSS - 🧩 Difficulty: Medium/Hard - 👩🏿...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
[grammar] ~13-~13: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~27-~27: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md
[grammar] ~2-~2: Ensure spelling is correct
Context: ...us: In Progress > Program participation annoucement can be found here https://github.com/or...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
[style] ~13-~13: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ...ructive feedback, and help contributors improve their coding skills. - Please also enc...
(IMPROVE_STRENGTHEN)
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md
[uncategorized] ~49-~49: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e notes are published, and the world of open source won again. Learn more about the [relea...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
[style] ~17-~17: Phrases like “ I think we” can make your message sound insecure. Consider making your writing sound more confident and self-assured.
Context: ...hrow exceptions from the main function. I think we should standardize this and propose a system b...
(I_THINK_WE_SHOULD)
[style] ~20-~20: Consider using a synonym to be more concise.
Context: ...y and we use GitHub Actions to automate lots of things in the organization. GitHub acti...
(A_LOT_OF)
[style] ~22-~22: Consider a different adjective to strengthen your wording.
Context: ...ub.com/asyncapi/cli) | @fmvilas | We're doing a great job at Glee and Generator and it's about th...
(DO_A_GREAT_JOB)
[grammar] ~24-~24: Ensure spelling is correct
Context: ...eople and companies doing serverless or Fuction-as-a-Service (FaaS). Making Glee integr...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~25-~25: ‘in difficulty’ might be wordy. Consider a shorter alternative.
Context: ... is probably the most complicated issue in difficulty. If we want people to adopt Glee in pro...
(EN_WORDINESS_PREMIUM_IN_DIFFICULTY)
[grammar] ~25-~25: Ensure spelling is correct
Context: ...dopt Glee in production, it needs to be prodution-ready, and that means being able to han...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
[typographical] ~23-~23: Consider using an en dash here instead of a hyphen.
Context: ...or their issues assigned/selected. - September - October: We determined if we could com...
(QB_NEW_EN_DASH_RULE_EN)
markdown/docs/community/050-mentorship-program/summerofcode/README.md
[style] ~5-~5: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ... contribute to open-source projects and improve their coding skills. If you want to dev...
(IMPROVE_STRENGTHEN)
[style] ~43-~43: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3630 characters long)
Context: ...I for your Google Summer of Code project!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
[style] ~11-~11: Consider replacing this word to strengthen your wording.
Context: ...ull requests. You are a language expert and can review docs or an expert in a speci...
(AND_THAT)
[style] ~15-~15: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: ...ues or in Slack You can help us out in many different ways. Just check out [this](https://allcontr...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~17-~17: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... if we failed in recognizing your work. Feel free to contact us on [slack](https://asyncapi....
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
[grammar] ~74-~74: Ensure spelling is correct
Context: ... In that case, AsyncAPI may require the Progam Administrators to designate a replacement Mentor and r...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~94-~94: Ensure spelling is correct
Context: ...iewed by the selected project Mentor to which they were submitted. A Mentor may accep...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[uncategorized] ~106-~106: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...licly accessible location and under an [Open Source Initiative approved license](http://www...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/COC-incident-resolution-procedures.md
[style] ~97-~97: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ... the nature of the allegations, if any, taking into consideration risks of retaliation, evidence tamperin...
(TAKE_INTO_CONSIDERATION)
[style] ~107-~107: ‘mutual agreement’ might be wordy. Consider a shorter alternative.
Context: ...torative Justice" below), mediation, or mutual agreement, the CoC Committee will wait until the ...
(EN_WORDINESS_PREMIUM_MUTUAL_AGREEMENT)
[style] ~107-~107: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tor may help facilitate the discussion. If the involved parties agree on an outcom...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~191-~191: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ided information, if only one person or a very small number of people were involved in or wi...
(EN_WEAK_ADJECTIVE)
[style] ~232-~232: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...t also outline what that member can and can not do as part of the investigation.
###...
(CAN_NOT_PREMIUM)
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md
[style] ~28-~28: ‘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] ~28-~28: ‘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)
markdown/docs/community/020-governance-and-policies/donating-projects.md
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...r both maintainers and contributors. - We make Intellectual Property (IP) Review ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md
[grammar] ~58-~58: Ensure spelling is correct
Context: ...** 175 Hours ## 7) Conference Website Maintainance Ensure our conference website remains a ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...at server to interact with the app. - Adding servers security - Add security detai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md
[style] ~2-~2: It’s more common nowadays to write this noun as one word.
Context: ...nsible for updating the document. --> | name | [chore: introduce govern...
(RECOMMENDED_COMPOUNDS)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
[style] ~40-~40: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...e to projects under AsyncAPI Initiative on a regular basis, and we'll welcome them as new maintain...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
[style] ~107-~107: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...r=blue" width=300 /> ### Contact Feel free to contact us if you need more explanation...
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
[uncategorized] ~50-~50: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ors can connect and collaborate.
- Open Source Contributions: Encourage contributions ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~51-~51: Ensure spelling is correct
Context: ...platforms like Slack, GitHub, LinkedIn, Mastadon, YouTube, and Twitter to facilitate dis...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~81-~81: Ensure spelling is correct
Context: ... the community manager: - By adding neccessary information from the Marketing Working ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~84-~84: Ensure spelling is correct
Context: ...cipation - Publish marketing blog every quater detailing the activity and update of th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~115-~115: Ensure spelling is correct
Context: ...ry major post on Twitter, LinkedIn, and Mastadon will link back to the website. - Encour...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[style] ~58-~58: Consider using an alternative to strengthen your wording.
Context: ... - when an existing open-source project wants to join the AsyncAPI umbrella (owner wa...
(WANT_KEEN)
[grammar] ~66-~66: Ensure spelling is correct
Context: ...a discussion or vote, you can use three emojies: * 👍 (vote for) * 👎 (vote against) * ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md
[grammar] ~45-~45: Ensure spelling is correct
Context: ...mitment**: 175 Hour Technical skills requried Typescript, nodejs, websocket, EDA b...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~57-~57: Ensure spelling is correct
Context: ...n that reacts on any push to master and checkes if voters file was edited. Then reads i...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~60-~60: In American English, abbreviations like “etc.” require a period.
Context: ...rs (social accounts, hire availability, etc) Learn more here https://github.com/as...
(ETC_PERIOD)
[style] ~141-~141: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...important, that endpoint should be done in a similar way as in our main CLI - https://github.com...
(IN_A_X_MANNER)
markdown/docs/community/020-governance-and-policies/CHARTER.md
[style] ~36-~36: Consider a more concise word here.
Context: ...ze of TSC. The size is expected to vary in order to ensure adequate coverage of important a...
(IN_ORDER_TO_PREMIUM)
[style] ~67-~67: ‘a majority of the’ might be wordy. Consider a shorter alternative.
Context: ...can only be removed upon resignation or a majority of the TSC votes. Next steps will be specified...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF_THE)
[style] ~93-~93: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...rovided in Section 6, decisions require a majority of votes. 4. Decisions must always be made...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cribe the contribution, the alternative open source license(s), and the justification for u...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... justification for using an alternative open source license for the Project. License except...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~119-~119: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...ject to approval by the Series Manager. In the event that a Project-specific CoC has not been app...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
[style] ~120-~120: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...opted, on its web site at least 30 days prior to such policy taking effect; provided, ho...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~127-~127: Consider replacing this phrase with the adverb “professionally” to avoid wordiness.
Context: ... 1. Engage in the work of the Project in a professional manner consistent with maintaining a cohesive ...
(IN_A_X_MANNER)
markdown/docs/community/020-governance-and-policies/voting.md
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...b.com/asyncapi/community) repository. - Voting automation works only with GitHub Issue...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~14-~14: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... Pull Requests. The Discussions should only be used for initial discussion, brainst...
(ONLY_EXCLUSIVELY_STYLE)
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md
[style] ~7-~7: Consider replacing this phrase with the adverb “transparently” to avoid wordiness.
Context: ...s have a voice and that the group works in a transparent manner. Multiple chairpersons can be elected i...
(IN_A_X_MANNER)
markdown/docs/community/onboarding-guide/github-actions.md
[style] ~99-~99: Consider a more expressive alternative.
Context: ...r to trigger it manually for you. To do this, reach out on Slack or open an iss...
(DO_ACHIEVE)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
[grammar] ~125-~125: Ensure spelling is correct
Context: ...ter/scripts/tools/categorylist.ts) from where you can opt the best category for your ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~125-~125: Ensure spelling is correct
Context: ...n opt the best category for your tools. Moreoever, if you don't find any, you can send us...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md
[style] ~79-~79: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4218 characters long)
Context: ...d let's build something awesome together!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
[style] ~44-~44: Consider using an alternative to strengthen your wording.
Context: ...at might get involved. (At AsyncAPI, we want to work with any TW, regardless of thei...
(WANT_KEEN)
[style] ~44-~44: Consider using a different adverb to strengthen your wording.
Context: ...look forward to mentoring TW(s) who are completely new to tech and making them feel welcom...
(COMPLETELY_ENTIRELY)
[typographical] ~49-~49: Consider using an en dash here instead of a hyphen.
Context: ... for the issues assigned/selected. - September - October: We determine if we can comple...
(QB_NEW_EN_DASH_RULE_EN)
[style] ~54-~54: Consider using “350” only; there is no need for the currency symbol because ‘dollars’ follows.
Context: ...ould also like to request an additional $350 dollars in our budget to provide cool s...
(REPEATED_CURRENCY)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[style] ~168-~168: Try using a synonym here to strengthen your writing.
Context: ...proved, contact Fran Mendez so he can give you access to all required tools. ## How...
(GIVE_PROVIDE)
[grammar] ~230-~230: Ensure spelling is correct
Context: ...Thank you.) . 8. A few moments later....Hurray! Your episode is now uploaded successful...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/070-marketing/webinar_series_initiative.md
[style] ~12-~12: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~39-~39: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
[style] ~75-~75: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uld be explicitly stated in the Scope. In case two Bounty Issues are inextricably...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~77-~77: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ust be explicitly stated in the Scope. In case the total reward for all submitted...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~124-~124: Consider simply using “of” instead.
Context: ...nty Issue (on Monday, the last activity of any of the abovementioned types was four or mo...
(OF_ANY_OF)
[style] ~147-~147: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... Issue Timeline extension should happen prior to any current milestone of the Bounty Iss...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~173-~173: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ered the one that reached End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~175-~175: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the one that reached the End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~177-~177: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ered the one that reached End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~182-~182: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ssue Candidate. A dropped Bounty Issue can not be assigned again to the same Bounty Pr...
(CAN_NOT_PREMIUM)
[style] ~195-~195: The phrase “taken into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...solution of the Bounty Issue, etc.) are taken into consideration only if they occurred after the additio...
(TAKE_INTO_CONSIDERATION)
[uncategorized] ~216-~216: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...elies on Open Collective's Fiscal Host 'Open Source Collective' to service payments and, th...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~216-~216: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...er they will be able to receive payment prior to starting participation in the Bounty Pr...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~216-~216: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...*. AsyncAPI will not take any action if Open Source Collective refuses to relay the payment...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md
59-59: Bare URL used
(MD034, no-bare-urls)
62-62: Blank line inside blockquote
(MD028, no-blanks-blockquote)
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md
2-2: Bare URL used
(MD034, no-bare-urls)
26-26: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
27-27: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
28-28: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
29-29: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
30-30: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
31-31: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
32-32: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md
11-11: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
19-19: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
29-29: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
35-35: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
39-39: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/050-mentorship-program/README.md
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md
21-21: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
22-22: Hard tabs
Column: 21
(MD010, no-hard-tabs)
24-24: Hard tabs
Column: 29
(MD010, no-hard-tabs)
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md
18-18: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
18-18: Bare URL used
(MD034, no-bare-urls)
19-19: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md
47-47: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
17-17: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
22-22: Hard tabs
Column: 21
(MD010, no-hard-tabs)
24-24: Hard tabs
Column: 29
(MD010, no-hard-tabs)
41-41: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/README.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h6
(MD001, heading-increment)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
28-28: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
43-43: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
44-44: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
6-6: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
8-8: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
8-8: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
8-8: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
11-11: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
11-11: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
11-11: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
25-25: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
43-43: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
64-64: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
78-78: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
112-112: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
114-114: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
115-115: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
120-120: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
123-123: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
markdown/docs/community/COC-incident-resolution-procedures.md
12-12: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
12-12: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
13-13: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
13-13: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
14-14: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
15-15: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
15-15: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
16-16: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 4; Actual: 3
(MD007, ul-indent)
21-21: Hard tabs
Column: 3
(MD010, no-hard-tabs)
22-22: Inconsistent indentation for list items at the same level
Expected: 3; Actual: 2
(MD005, list-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
22-22: Hard tabs
Column: 1
(MD010, no-hard-tabs)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
24-24: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
26-26: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
27-27: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
28-28: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
32-32: Images should have alternate text (alt text)
(MD045, no-alt-text)
103-103: Images should have alternate text (alt text)
(MD045, no-alt-text)
108-108: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
63-63: Hard tabs
Column: 15
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 38
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 51
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 19
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 26
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 12
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 122
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 18
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 186
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 194
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 12
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 84
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 91
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 23
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 97
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 104
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 19
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 99
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 105
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 19
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 278
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 285
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 14
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 147
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 155
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 23
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 469
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 475
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 25
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 481
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 489
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 25
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 427
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 435
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 28
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 109
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 137
(MD010, no-hard-tabs)
markdown/docs/community/020-governance-and-policies/voting.md
35-35: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
markdown/docs/community/onboarding-guide/github-actions.md
58-58: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
59-59: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
60-60: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
70-70: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
71-71: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
72-72: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
101-101: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
63-63: Hard tabs
Column: 15
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 38
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 51
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 19
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 26
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 12
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 122
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 18
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 186
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 194
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 12
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 84
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 91
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 23
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 97
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 104
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 19
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 99
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 105
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 19
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 278
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 285
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 14
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 147
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 155
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 23
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 469
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 475
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 25
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 481
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 489
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 25
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 427
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 435
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 28
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 109
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 137
(MD010, no-hard-tabs)
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md
4-4: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
11-11: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
16-16: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
48-48: Hard tabs
Column: 21
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 32
(MD010, no-hard-tabs)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
16-16: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
17-17: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
47-47: Images should have alternate text (alt text)
(MD045, no-alt-text)
51-51: Images should have alternate text (alt text)
(MD045, no-alt-text)
58-58: Images should have alternate text (alt text)
(MD045, no-alt-text)
62-62: Images should have alternate text (alt text)
(MD045, no-alt-text)
66-66: Images should have alternate text (alt text)
(MD045, no-alt-text)
70-70: Images should have alternate text (alt text)
(MD045, no-alt-text)
74-74: Images should have alternate text (alt text)
(MD045, no-alt-text)
84-84: Images should have alternate text (alt text)
(MD045, no-alt-text)
88-88: Images should have alternate text (alt text)
(MD045, no-alt-text)
92-92: Images should have alternate text (alt text)
(MD045, no-alt-text)
94-94: Images should have alternate text (alt text)
(MD045, no-alt-text)
96-96: Images should have alternate text (alt text)
(MD045, no-alt-text)
100-100: Images should have alternate text (alt text)
(MD045, no-alt-text)
104-104: Images should have alternate text (alt text)
(MD045, no-alt-text)
110-110: Images should have alternate text (alt text)
(MD045, no-alt-text)
117-117: Images should have alternate text (alt text)
(MD045, no-alt-text)
121-121: Images should have alternate text (alt text)
(MD045, no-alt-text)
125-125: Images should have alternate text (alt text)
(MD045, no-alt-text)
196-196: Bare URL used
(MD034, no-bare-urls)
204-204: Bare URL used
(MD034, no-bare-urls)
206-206: Bare URL used
(MD034, no-bare-urls)
208-208: Bare URL used
(MD034, no-bare-urls)
210-210: Bare URL used
(MD034, no-bare-urls)
212-212: Bare URL used
(MD034, no-bare-urls)
214-214: Bare URL used
(MD034, no-bare-urls)
216-216: Bare URL used
(MD034, no-bare-urls)
234-234: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/070-marketing/webinar_series_initiative.md
146-146: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
26-26: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
26-26: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
33-33: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
64-64: Bare URL used
(MD034, no-bare-urls)
92-92: Bare URL used
(MD034, no-bare-urls)
208-208: Bare URL used
(MD034, no-bare-urls)
248-248: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
248-248: Bare URL used
(MD034, no-bare-urls)
249-249: Bare URL used
(MD034, no-bare-urls)
250-250: Bare URL used
(MD034, no-bare-urls)
251-251: Bare URL used
(MD034, no-bare-urls)
252-252: Bare URL used
(MD034, no-bare-urls)
253-253: Bare URL used
(MD034, no-bare-urls)
⏰ 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). (4)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (16)
markdown/docs/community/011-styleguide/numbers.md (1)
158-159: Formatting fix looks goodThe removal of the stray leading hyphen normalises list formatting and matches the style used elsewhere in the document.
markdown/docs/community/011-styleguide/grammar.md (1)
75-76: Minor list-bullet cleanup acceptedEliminating the extra hyphen prevents a double-bullet rendering glitch. No further change required.
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1)
80-88: Property name inconsistency:languagesvslanguageEarlier in the guide the schema defines
filters.language(singular), but the YAML Bundler example showslanguages:. Using the plural key will cause the weekly workflow to reject the file as invalid.Align the example with the schema (
language:) or clarify that both keys are accepted.markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
47-47: Good motivational closeThe added closing sentence is concise and encouraging. Nice touch.
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
99-101: Bullet-list correction looks goodThe extra hyphen was removed and the list now renders correctly.
No further action needed.markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
27-35: Broken internal links – leading “/asyncapi/…” goes nowhereLines 28 and 34 point to
/asyncapi/community/blob/master/git-workflow.mdand
https://github.com/asyncapi/community/blob/master/docs/010-contribution-guidelines/conventional-commits.md• The first link misses the scheme/host, so it resolves relative to the current site and 404s.
• Using a hard-coded GitHub URL forconventional-commits.mdis inconsistent with the rest of the doc set, which uses relative links rendered in-site (better UX + fewer external hops).Prefer consistent, relative paths (e.g.
../git-workflow.mdandconventional-commits.md) unless there is a deliberate reason to force GitHub.markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
15-17: Verify relative paths after directory moveThe links now step up a level (
../010-contribution-guidelines/...).
Double-check that the website’s build root for community docs matches this relative path; if the page renders under/community/000-onboarding/, the new target resolves to/community/010-contribution-guidelines/..., which is correct.
Flagging in case the build pipeline still prependsdocs/and ends up duplicating the segment.markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (1)
1-4: Generated file – no manual editsThe header already warns readers; looks good. No action required.
markdown/docs/community/070-marketing/webinar_planning_template.md (1)
1-63: Template reads well – no issues spottedStructure, front-matter, and checklist are clear and lint-clean. Nice addition.
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
49-57: Optional: clarify tech-stack bulletThe skills bullet lists only TS/JS+React, yet dynamic OG images typically require a rendering backend (e.g. Vercel OG, Satori).
Consider mentioning the expected approach so applicants scope the work correctly.markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1)
11-23: Member count mismatch.
Document states “3 full members and 3 alternate members” but only lists 2 alternates. Add a third alternate or adjust the stated count to avoid confusion.markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (1)
74-75: Unit capitalisation mismatch
175 hours(lower-case “hours”) is inconsistent with previous “175 Hours”. Pick one style (title-case or lower-case) and apply everywhere.markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (1)
76-77: Link path may be staleLink points to
/community/blob/master/git-workflow.md. In this PR the guide seems to live under010-contribution-guidelines/git-workflow.md. Please verify and update.markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md (1)
54-58: Verify Charter link path.The link points to
community/blob/master/docs/020-governance-and-policies/CHARTER.md#2-technical-steering-committee; on the website these docs are served without thedocs/prefix.
Double-check the rendered URL doesn’t 404.markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (1)
37-38: Code-block fence syntax typoThe opening fence reads “
mermaid” (space before `mermaid`). Common Markdown processors and Mermaid-JS expect “mermaid” without the space; keeping it tight avoids rendering issues.markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (1)
248-248: Heading-level jump (h2 ➞ h5) violates MD001The “Sources” subsection jumps three levels (
#####). Increment only one level at a time to keep document hierarchy valid.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add YAML front-matter before publishing
All content pages under markdown/docs/ are expected to start with a
--- block containing at least title, description, and weight.
Without it, the page renders without metadata and may break sidebar
ordering.
Example front-matter:
+---
+title: How to contribute
+description: Step-by-step guide for first-time AsyncAPI contributors.
+weight: 10
+---
+
🚧 This document is under construction.
Please be patient as we work on it. Thank you. 🫶📝 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.
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 | |
| --- | |
| title: How to contribute | |
| description: Step-by-step guide for first-time AsyncAPI contributors. | |
| weight: 10 | |
| --- | |
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 |
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/how-to-contribute.md at the beginning
of the file (lines 1 to 3), add a YAML front-matter block with at least the keys
title, description, and weight. This block should be enclosed by triple dashes
(---) to ensure the page renders correctly with metadata and maintains proper
sidebar ordering.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing required front-matter
Same issue as in how-to-contribute.md: add a YAML header so the page
is picked up by the docs generator and sorted correctly.
Suggested skeleton:
+---
+title: Documentarian onboarding guide
+description: Orientation for contributors focused on improving docs.
+weight: 20
+---
+
🚧 This document is under construction.
Please be patient as we work on it. Thank you. 🫶📝 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.
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 | |
| --- | |
| title: Documentarian onboarding guide | |
| description: Orientation for contributors focused on improving docs. | |
| weight: 20 | |
| --- | |
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 |
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md at
the beginning of the file (lines 1 to 3), the document is missing the required
YAML front-matter header. Add a YAML front-matter block at the top of the file
similar to the one used in how-to-contribute.md to ensure the docs generator
recognizes and sorts the page correctly. The front-matter should include keys
like title, description, and any other metadata required by the docs system.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provide metadata header
Add front-matter to keep the onboarding set consistent and prevent
broken navigation links.
+---
+title: Where to contribute
+description: Overview of AsyncAPI projects and repositories open for help.
+weight: 30
+---
+
🚧 This document is under construction.
Please be patient as we work on it. Thank you. 🫶📝 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.
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 | |
| --- | |
| title: Where to contribute | |
| description: Overview of AsyncAPI projects and repositories open for help. | |
| weight: 30 | |
| --- | |
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 |
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/where-to-contribute.md at the
beginning of the file (lines 1 to 3), add a front-matter metadata header
consistent with other onboarding documents. This should include necessary fields
like title, description, and any identifiers used for navigation to ensure the
document integrates properly and prevents broken links in the onboarding set.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ROADMAP page needs front-matter
Road-map pages are often linked from multiple places; lack of metadata
hurts SEO and sidebar ordering. Add a header similar to:
+---
+title: AsyncAPI Roadmap
+description: High-level roadmap and milestones for the AsyncAPI project.
+weight: 5
+---
+
🚧 This document is under construction.
Please be patient as we work on it. Thank you. 🫶📝 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.
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 | |
| --- | |
| title: AsyncAPI Roadmap | |
| description: High-level roadmap and milestones for the AsyncAPI project. | |
| weight: 5 | |
| --- | |
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 |
🤖 Prompt for AI Agents
In markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md at the
beginning (lines 1 to 3), the file is missing front-matter metadata which is
important for SEO and sidebar ordering. Add a YAML front-matter block at the top
of the file including title, description, and any relevant tags or ordering
information consistent with other roadmap pages in the project.
| | | Hacktoberfest | 18 | ||
| | 2022 | AsyncAPI Mentorship | 10 | 41 | | ||
| | | GSoD | 6 | | | ||
| | | Hacktoberfest | 12 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Statistics table has uneven columns – data is dropped
Row | | Hacktoberfest … lacks the last cell and trailing pipe, causing the “Total” column to shift and Markdown-lint to raise MD056.
Add an empty cell and trailing pipe:
| | Hacktoberfest | 18 | |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/README.md around lines 34 to
37, the statistics table has uneven columns because the row starting with "|
| Hacktoberfest" is missing the last cell and trailing pipe. Fix this by adding
an empty cell and a trailing pipe at the end of that row to align with the other
rows and prevent the "Total" column from shifting.
| If they subscribe or publish to the same channels | ||
| If one subscribes to a channel that the other one publishes to | ||
| If there are apps that are subscribed to channels that no one publishes too | ||
| As an output, we should get a format that can be used to generate a diagram of relations between applications with additional metadata information about them (message, schemas). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo – “too” → “to”
“…channels that no one publishes **too**” should be “…publishes to”.
Tiny but visible error in a public guide; fix keeps the document professional.
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
around lines 30 to 33, correct the typo by changing "too" to "to" in the phrase
"channels that no one publishes too" to "channels that no one publishes to" to
maintain professionalism in the public guide.
| - By adding neccessary information from the Marketing Working Group. | ||
| - Promote the newsletter in the community for more visibility. | ||
| - Encourage community subscription and participation | ||
| - Publish marketing blog every quater detailing the activity and update of the marketing working group. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix spelling errors: “neccessary” → “necessary”; “quater” → “quarter”
These typos occur in publicly visible strategy text and undermine credibility.
🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Ensure spelling is correct
Context: ... the community manager: - By adding neccessary information from the Marketing Working ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~84-~84: Ensure spelling is correct
Context: ...cipation - Publish marketing blog every quater detailing the activity and update of th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
around lines 81 to 85, fix the spelling errors by changing "neccessary" to
"necessary" and "quater" to "quarter" to ensure the text is professional and
credible.
| | **AsyncAPIConnect X (Twitter) Space//LinkedIn Live** | A webinar that provides an overview of AsyncAPI, its purpose, and how to get started | | | ||
| | **BuildBetter with AsyncAPI: Advanced AsyncAPI Usage** | Workshops focusing on more advanced usage and integrations of AsyncAPI | | | ||
| | **Contributing to AsyncAPI** | A guide to contributing to AsyncAPI, including coding standards, docs, design, GitHub usage, and community norms | | | ||
| | **AsyncAPI Ask Me Anything (AMA) Sessions** | Open Q&A sessions with core maintainers and community leaders | | ||
| | **AsyncAPI Podcast: The Future of APIs** | A monthly podcast to discuss API trends, event-driven architectures, AsyncAPI adoption, and real-world implementations. | | ||
|
|
||
| ### Hackathons | ||
| To encourage hands-on learning and adoption of AsyncAPI, we will organize hackathons. | ||
|
|
||
| | **Challenge** | **Description** | | | ||
| |-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------| | ||
| | **AsyncAPI Hackathon** | An AI hackathon focused on building innovative solutions using AsyncAPI data and existing technology. | | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Replace hard TABs in the events table
The table rows contain embedded TAB characters (MD010) which break alignment in many Markdown renderers. Convert to spaces to ensure predictable layout.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
63-63: Hard tabs
Column: 15
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 38
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 51
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 19
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 26
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 12
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 122
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 18
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 186
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 194
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 12
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 84
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 91
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 23
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 97
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 104
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 19
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 99
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 105
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 19
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 278
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 285
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 14
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 147
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 155
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 23
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 469
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 475
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 25
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 481
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 489
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 25
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 427
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 435
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 28
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 109
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 137
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
between lines 63 and 75, the Markdown tables contain hard TAB characters that
disrupt alignment in many renderers. Replace all TAB characters within the table
rows with spaces to ensure consistent and predictable table layout across
different Markdown viewers.
| #### Restream-first | ||
|
|
||
| You must start with YouTube first, even though Restream can directly stream there. It is because by | ||
|
|
||
| This is what you need to do to kick it off: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incomplete sentence breaks the flow
The paragraph starting with “You must start with YouTube first…” ends abruptly: “It is because by”. Readers are left without the rationale. Please complete or remove the sentence.
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 76 to 80, the sentence starting with "You must start with YouTube
first..." ends abruptly with "It is because by". Complete this sentence to
provide the rationale for starting with YouTube first or remove the incomplete
fragment to maintain the flow and clarity of the paragraph.
| 4. No more than one-fourth of the TSC members may be affiliated with the same employer. If the removal or resignation of a TSC member, or a change of employment/affiliation by a TSC member, creates a situation where more than one-fourth of the TSC membership shares an employer, then the situation must be assessed by TSC. In any case, the number of TSC members affiliated with the same employer must not be higher than one-third (round half up number). | ||
| 5. Voting members of the Technical Steering Committee (TSC) include committers of any Project's code repository and AsyncAPI Ambassadors. The TSC documents in the project’s GOVERNANCE file the method for determining voting members. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Conflicting employer-quota numbers (¼ vs ⅓)
Clause 4 says “No more than one-fourth” may share an employer, but the follow-up sentence caps it at “one-third”. These limits are contradictory—please reconcile to a single threshold to avoid governance ambiguity.
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/CHARTER.md around lines
37 to 38, the employer affiliation limits for TSC members conflict by stating
both one-fourth and one-third as maximum thresholds. Choose a single consistent
fraction (either one-fourth or one-third) and update both sentences to use that
same limit to remove ambiguity in the governance rules.
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation