docs(community): update latest community documentation #4223
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
quetzalliwrites and
sambhavgupta0705
as code owners
❌ Deploy Preview for asyncapi-website failed.
|
WalkthroughThis update introduces an extensive suite of new and revised community documentation for AsyncAPI. It adds governance, policies, onboarding, contribution guidelines, mentorship program details, style guides, meeting organization, marketing strategy, and more. Numerous new markdown files and configuration entries are included, with several placeholder documents and substantial guides on processes, programs, and community structure. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant CommunityDocs
participant Maintainer
participant TSC
participant Bot
Contributor->>CommunityDocs: Reads onboarding/contribution/governance guides
Contributor->>Maintainer: Submits PR or issue (per guidelines)
Maintainer->>TSC: Reviews, approves, or escalates (per governance)
Bot->>Contributor: Sends notifications (e.g., for meetings, voting, mentorship)
Maintainer-->>Contributor: Provides feedback, merges, or requests changes
TSC->>CommunityDocs: Updates governance, policies, or program docs as needed
Possibly related issues
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
|
asyncapi-bot
requested review from
Aahil13,
VaishnaviNandakumar,
ashmitjsg and
vishvamsinh28
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 #4223 +/- ##
=========================================
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:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 15
🔭 Outside diff range comments (2)
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
27-34: Fix broken links to the Git Workflow GuideThe root-relative links
/asyncapi/community/blob/master/git-workflow.md
resolve tohttps://www.asyncapi.com/asyncapi/...and return 404. Please update both occurrences inmarkdown/docs/community/010-contribution-guidelines/contribution-flow.md:• Line 28 – change
[git workflow guide](/asyncapi/community/blob/master/git-workflow.md)
to the absolute GitHub URL:
https://github.com/asyncapi/community/blob/master/git-workflow.md• Line 34 – change
[git workflow document](/asyncapi/community/blob/master/git-workflow.md)
to the same absolute URL aboveAlternatively, for intra-site navigation, use a relative link to the local file:
[git workflow guide](git-workflow.md)(or../git-workflow.md).
This will align with other references in the repo and prevent dead links.markdown/docs/community/050-mentorship-program/README.md (1)
29-41: Markdown table malformed — missing closing pipes.Rows 34, 37, 40 lack a terminating
|, which breaks table rendering. Please add the missing pipe delimiters.
🧹 Nitpick comments (102)
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (3)
3-4: Tighten opening paragraphs for clarity and punctuation
Several minor grammar issues lower readability:
- Line 3: Insert a comma after “problem,” → “…to a problem, instead of fully diving…”.
- Line 6: The sentence after the quoted word “substantial,” starts with a capital “We” but is still part of the same sentence. Consider “…are substantial, we ask that these…” (lower-case we).
- Line 11: Serial wording would read better with a comma → “…document it, and create a proposal…”.
[uggest_nitpick]Also applies to: 8-11
21-25: Comma before coordinating ‘so’
Line 21 contains two independent clauses joined by “so”. Add a comma before “so” to avoid a run-on sentence.
45-50: Typos & tone
- Line 49: “open source won again” reads oddly; maybe “open source wins again”.
- Line 65: “preperation” → “preparation”.
These small fixes will polish the document.markdown/docs/community/000-onboarding/how-to-contribute.md (1)
1-3: Add front-matter to keep placeholder pages consistentSame concern as in ROADMAP.md: missing front-matter may cause build or SEO issues. Copy the pattern used by other onboarding docs and optionally mark the page as draft.
markdown/docs/community/000-onboarding/where-to-contribute.md (1)
1-3: Front-matter is also missing hereReplicate the minimal front-matter used elsewhere to avoid build warnings and make future completion easier.
markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md (1)
1-3: Placeholder lacks required front-matterEvery doc page should start with a YAML front-matter block (
--- title: … ---) so the website build can pick it up and place it in navigation.
Please add at minimum atitle,weight, and, if appropriate,draft: trueuntil the content is ready.
Without it, the page will still be rendered but will miss SEO metadata and might be omitted from the TOC.markdown/docs/community/070-marketing/social-media-communication-guidelines.md (1)
1-3: Missing front-matter headerSame observation as for the onboarding guide: add a YAML header so the marketing section is properly indexed.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)
21-23: Bare URL and HTML<del>inside tableMarkdown-lint flags the naked URL; wrap it in link syntax for consistency.
Also, GitHub supports
~~strike~~inside tables but<del>often breaks table layout in some engines (including docusaurus). Replace<del>…</del>with~~…~~or drop the row entirely.These tweaks improve rendering and lint scores.
config/edit-page-config.json (2)
23-41: Duplicate/overlapping style-guide entriesYou now have:
"community/styleguide"(existing)"community/011-styleguide"(new)Unless both paths are intentionally distinct, one of them will never match and only add noise to the list. Consider consolidating to a single canonical path.
31-65: Keep list order deterministicThe newly-appended community blocks are inserted in the middle of the array.
For long JSON lists, alphabetical (or logical) ordering helps future diffs and reviewers. You may want to move the new objects together or sort the whole list.Not a blocker, just a maintainability hint.
markdown/docs/community/040-guides/keep-repository-settings-consistent.md (2)
11-11: Minor article omission“Make sure Sponsorships option is selected…” → insert “the” before Sponsorships for smoother reading.
29-31: Subject-verb agreement / wording“global workflows … cover mostly all the needs for most of the repositories” reads awkwardly. Consider “cover most needs for repositories” or “mostly cover all needs”.
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (2)
3-4: Heading level jump (MD001)
##### Introductionskips from H1 to H5. Use H2 (##) to maintain a one-level increment.
11-15: Very long bullet decreases readabilityThe first bullet contains three distinct responsibilities in one sentence. Splitting into sub-bullets will improve scannability for mentors skimming the doc.
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (1)
18-18: Comma before coordinating conjunction“In 2022, GSoD at AsyncAPI had 2 projects**,** and we hired 6 Technical Writers …” – add the comma to follow compound-sentence grammar.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (3)
4-4: Heading level jump
### Ideas listshould be## Ideas listto follow H1 → H2 hierarchy.
9-10: Wording issue“AMQP 1.0 is the one of the most used protocols…” – drop “the” → “is one of the most used”.
14-14: Trademark formattingUse “Node.js” instead of “NodeJS” / “Nodejs” to follow official naming conventions.
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (3)
2-2: Typos“annoucement” → “announcement”.
12-13: Incorrect ordinal“23th January” → “23rd January”. Same check for other dates if present.
25-33: Markdown table styleTable rows lack trailing pipes, triggering
MD055. Consistent pipes improve rendering across viewers.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (2)
9-9: Missing space in “18weeks”.
12 to 18weeksshould read12 to 18 weeksfor clarity.
11-22: Table lacks trailing blank line.Markdown tables render more reliably when surrounded by blank lines. Add a blank line after the table (current file ends immediately after the table).
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md (2)
3-7: Heading-level jump (MD001).The first sub-heading after
# Status: Completedis### Timeline; it should be## Timelineto keep heading levels incremental.
18-18: Use official spelling “Node.js”.Project 5 title uses “NodeJS”. Replace with “Node.js” for correctness.
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (4)
7-8: Heading-level jump (MD001).
### Contact informationshould be## Contact information(and subsequent sections shifted accordingly).
13-13: Spacing around parenthesis.
Contact Number(include your country code)→Contact number (include your country code).
32-32: Missing comma before “demonstrating”.
abilities(Optional)also lacks a space. Suggest: “abilities (optional).”
39-39: Preposition choice.“independently of the official AsyncAPI project” is the correct collocation, not “independently from”.
markdown/docs/community/050-mentorship-program/README.md (1)
14-15: Capitalization of “Slack”.
AsyncAPI slack→AsyncAPI Slack.markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (2)
24-24: Blank lines around table (MD058).Insert a blank line before and after the table section to satisfy Markdown-lint and improve readability.
33-33: Spelling: “Maintainance” → “Maintenance”.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (4)
1-1: Fix heading grammar“Projects ideas” should be “Project ideas” (singular adjective).
11-11: Polish sentence – unclear wording and comma misuseThe phrase “Community uses diff protocols, because everyone has diverse needs.” mixes shorthand (“diff”) and has an unnecessary comma before because. Consider:
Community members use different protocols because everyone has diverse needs.
12-12: Correct technology and spelling references
- “NodeJS” ➜ “Node.js” (official spelling).
- “engile” ➜ “engine”.
These appear in the same sentence describing the template rewrite.
27-27: Consistent terminology & stronger wordingThe sentence uses both “visualiser” and “visualizer”; pick one spelling (the repo uses “Visualizer”).
Also, “a good solution would be to add” is weak—consider “Add the ability to …”.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (3)
12-13: Typos in bullet list
- “Specifing” ➜ “Specifying”.
- “Securing operations” bullet is fine, but ensure bullets start with capital letters consistently.
21-21: Plural noun“specify thing that are common” ➜ “specify things that are common”.
29-30: Extraneous double-spaceThere is an extra space before “learning” in “a learning experience”.
markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (2)
1-1: Missing definite articleInsert “The” at the beginning: “The AsyncAPI Community uses Slack …”.
10-10: Missing comma before a clauseAdd a comma after “details”:
“… is mentioned in the message. For more details, read …”markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (4)
5-5: Missing article“ We use the [All Contributors] specification …” – insert “the”.
9-10: Tense & clarity“You come up with the idea that we used to do something great with the project.” is hard to parse.
Suggested: “If you share feedback on Slack or another channel that leads to an improvement in the project.”
13-13: Grammar“Answer to questions” ➜ “Answer questions”.
21-22: Article before countable noun“In a closed issue or pull request” instead of “in closed issue”.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (2)
13-14: Comma after introductory clauseInsert a comma after “requirements”:
“# Blog post requirements
Please observe the following requirements, for all AsyncAPI blog post contributions:”
18-20: List indentation & link formattingThe sub-list under “Place all images…” is indented with three spaces, violating MD007.
Also convert the bare URL to markdown link syntax to satisfy MD034.markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
58-66: Spelling & punctuation issues in the Conference Website item
- “Maintainance” → “Maintenance” (line 58)
- Sentence reads awkwardly: “Ensure our conference website remains a dynamic and user-friendly for the upcoming 2024 AsyncAPI Conference.” – remove the article “a” before “dynamic”.
- Mentor list (line 64) is missing commas after each GitHub handle, making it hard to scan.
Tidying these small language glitches will improve professionalism.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (2)
31-34: Trailing double-space and informal apology phrasingThere are two consecutive spaces after “quickly.” (line 33). Also, the parenthetical apology “no one intends to ignore you 🙏🏼” is friendly but reads quite informal for guidelines — consider a neutral tone (“…no one intends to ignore you.”).
43-44: Comma missing after “For example”“For example [see this PR …]” (line 43) should have a comma after “For example”.
markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
27-31: Capitalisation consistencyBullet “Be community-oriented:” (line 29) is lowercase after “Be”, whereas the other bullets use title-case nouns (“Respectful”, “Inclusive”). Consider “Be Community-Oriented” for consistency.
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1)
28-29: Long compound sentence may hinder readabilityThe decision-making paragraph (line 28) is a single ~90-word sentence. Breaking it into shorter sentences will improve comprehension for non-native readers.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (2)
1-4: Heading wordingTitle is “Projects ideas”; grammatical form should be “Project ideas”.
5-7: Table styling breaks markdownlint rulesThe header row is missing leading/trailing pipes, and there is no blank line before/after the table, triggering MD055/MD058. Aligning with the existing docs’ table style prevents future linter noise.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (3)
6-14: Use en dashes for date ranges and keep tense consistentThe timeline mixes hyphens with the word “–” conventions (e.g.,
February 22 - March 20).
Replace the hyphen with an en dash (–) and keep one spacing rule across the list.
Example:February 22 – March 20.
It makes the markdown easier to read and aligns with AsyncAPI writing style.
43-47: Pluralisation, typo and casing
- “175 Hour” → “175 hours” (plural, lower-case).
- “Technical skills requried” → “Technical skills required”.
- “nodejs” → “Node.js”.
Cleaning these three small glitches removes avoidable friction for readers.
56-60: Grammar and wording in automation description
checkes if voters file was edited→checks whether the VOTERS file was edited.Also consider adding “the” before “single list” for clarity.
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (1)
26-28: “type of contributions” plural agreementSome clarifications on the type of contributions:
typeshould be plural to matchcontributions
Recommendation: “types of contributions”.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (3)
13-14: Typo: “Specifing” → “Specifying”Spotted in the bullet “Specifing dynamic parts of channel name”.
44-45: Replace hyphen with en dash in numeric range“4-6 months” → “4 – 6 months” for consistency with date-range guidance elsewhere.
54-55: Avoid repeating the currency symbol
$350 dollarsis redundant. Use either$350or350 dollars.markdown/docs/community/010-contribution-guidelines/git-workflow.md (3)
14-16: Use the current default branch name (main) instead ofmaster.Many AsyncAPI repos – and GitHub’s own defaults – now use
main. Referring tomasterin rules and examples can confuse newcomers who fork a repo whose default branch ismain. Please audit the document for occurrences ofmasterand update accordingly (including commands further below).
22-24: Step-4 wording does not match the GitHub UI.The checkbox is labelled “Copy the
mainbranch only” in the current UI, not “DEFAULT”. Consider updating the text to avoid mismatches when users follow the instructions.
70-75:git remote addexample URL is malformed.
https://ORIGINAL-OWNER/ORIGINAL-REPOSITORY-NAME.gitlacks the GitHub host (github.com). Typing it verbatim will fail. Recommend showing the full formhttps://github.com/ORIGINAL-OWNER/REPO.git(or the SSH variant) for clarity.markdown/docs/community/COC-incident-resolution-procedures.md (2)
12-16: List indentation breaks markdown-lint rules.Lines 12-16 have inconsistent indentation / mixing of tabs, triggering
MD005,MD007,MD010. Rendering in some markdown engines collapses the TOC structure. Please normalise list levels (two-space indents, no hard tabs) and re-runmarkdownlint.
80-82: Missing protocol in Slack link.
asyncapi.slack.com(line 80) renders as plain text. Prefix withhttps://so the link is clickable:https://asyncapi.slack.com.markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (1)
60-63: Use the correct “Node.js” spelling throughout.Lines 62, 71 and 80 use “Node js”. Consistent brand spelling (“Node.js”) improves professionalism and avoids lint warnings (
NODE_JS).Also applies to: 71-72, 80-81
markdown/docs/community/020-governance-and-policies/voting.md (1)
24-26: Quorum example mis-computes 51 % of 40 members.51 % × 40 = 20.4, so the minimum whole-number quorum is 21. The text already says “at least 21”, but the preceding math explanation can confuse readers. Consider rewriting the sentence to “For 40 members, quorum is 21 (51 % rounded up).”
markdown/docs/community/onboarding-guide/github-actions.md (1)
70-76: Brand names and bullet style consistency.• “nodejs” in the topic list should be “Node.js”.
• Bullets in this section use asterisks, whereas earlier sections use dashes; markdown-lint (MD004) flags the mix. Align to a single bullet style for the file.markdown/docs/community/050-mentorship-program/summerofcode/README.md (4)
10-18: Pluralise and clarify the “Requirement” section title
The section describes several conditions, so the heading should read “### Requirements”. This small change improves clarity and avoids nit-picks from docs linters.
22-34: Replace bare URLs with absolute links & tighten wording
Several list items mix raw URLs and relative Markdown links. Consider using the fullhttps://form everywhere for consistency, and shorten long sentences (e.g. “Carefully read through the guide …” can be two sentences).
35-40: Missing serial comma in multi-line list item
Line 39 is a single list item containing multiple clauses joined by commas but no serial comma before the final “and”. This makes the sentence hard to parse.
41-44: Excess exclamation mark
Ending the closing sentence with an exclamation adds unnecessary emphasis. Drop it for a more neutral tone.markdown/docs/community/020-governance-and-policies/donating-projects.md (3)
3-6: Insert missing article “The” before “AsyncAPI initiative”
Grammar nit: “The AsyncAPI initiative is open …” reads correctly and aligns with the style used elsewhere in the docs set.
36-41: Tighten sentence—no comma before essential “because” clause
Line 38 currently reads “…to the organization, because the Technical Steering Committee…”. The comma is unnecessary and flagged by LanguageTool.
47-50: Use parallel verb forms in the bullet list
Bullets 47-49 start with gerunds (“Ongoing”, “Documentation”) while 50 uses “Community”. Convert to “Community Support” for parallelism and consistency.markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (2)
51-54: Replace “behave with respect to” with concise phrasing
Line 53: “Always behave with respect to the AsyncAPI Code of Conduct” → “Always follow the AsyncAPI Code of Conduct”. Removes wordiness flagged by LanguageTool.
66-70: Typo in “emojies”
Plural of emoji is “emoji” (or “emojis”). Minor documentation polish.markdown/docs/community/020-governance-and-policies/CHARTER.md (2)
36-38: Avoid “in order to” wordiness
Line 36 could read “…vary to ensure adequate coverage…”—simpler and satisfies LanguageTool hint.
49-57: Compound “sub-project” inconsistently hyphenated
Lines 49-52 alternate between “sub-project” and “subproject”. Pick one form (AsyncAPI docs usually prefer “sub-project”).markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (3)
24-40: Indentation off by two spaces in definition list
Lines 25-40 trigger MD007. Remove the extra two-space indent so bullet points align flush-left with their parent section.
85-88: Grammar: missing preposition after “Apply”
Line 85 heading reads “How To Apply Ensure you’re eligible…”. Insert a colon or break the sentence: “How to Apply\n\nEnsure …”.
127-133: “Amount of stipends” → “number of stipends”
Stipends are countable. Adjust wording per LanguageTool hint.markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (4)
53-53: Grammar: “be inform” → “be in the form”.-This could be inform of the Bounty Program. +This could be in the form of the Bounty Program.
81-85: Typos: “neccessary” → “necessary”, “quater” → “quarter”.Fixing these avoids looking un-professional.
86-99: Brand spelling: “Mastadon” → “Mastodon”.Consistent naming improves searchability.
102-102: Tautology: “SEO Optimization” → just “SEO”.The “O” already stands for Optimization.
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
16-16: Heading style – use real headings, not bold/italics.Lines 16 and similar (“## 1) …”) are fine, but lines 34/45 use
**Use case**/**Required knowledge**as faux-headings. Replace with### Use caseetc. This clears MD036 and improves navigation.markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (2)
70-75: Subject/verb agreement and missing articles.Line 74: “doesn't matches” → “doesn't match”.
Also add “the” before “list”.-If your tool doesn't matches with any categories specified in list +If your tool doesn't match any categories specified in the list
24-25: Bare URLs – wrap in<https://…>or use markdown links.This avoids MD034 violations and makes links clickable in all renderers.
markdown/docs/community/styleguide/version-control.md (2)
57-57: Double-space typo.
### When Submitting Changeshas two spaces; remove one.
94-94: Extra space.“patterns shown in existing” → single space after “shown”.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (1)
107-108: Polish closing sentence.“Write an email to info@asyncapi.io.” improves grammar.
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (2)
7-8: Replace wordy phrase with concise adverb“…that the group works in a transparent manner” → “…that the group works transparently”.
This improves readability and addresses the
IN_A_X_MANNERstyle hint.
20-21: Tighten awkward wordingCurrent sentence is hard to parse:
“…communicate through official channels all relevant discussions and implementations that want to suggest to others.”
Consider:
“ …communicate through official channels any discussions or proposals they want to share with others.”markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
16-18: Consistent bullet-list marker requiredMarkdown-lint (
MD004) flags the mix of*and-.
Use one style (the rest of the doc mainly uses-).Example diff:
-* `Regular` meetings: ... -* `Ad Hoc` meetings: ... +- `Regular` meetings: ... +- `Ad Hoc` meetings: ...markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (2)
4-11: Remove trailing colon from headings
MD026flags headings 4, 11 and 16 that end with “:”. Trailing punctuation is discouraged.-## Current Challenges: +## Current ChallengesApply to all affected headings.
37-43: Use standard code-fence for mermaidPrefer
```mermaid(no space) so some renderers recognise the diagram automatically:-``` mermaid +```mermaidmarkdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (2)
13-14: Hyphenate compound adjective“individual open source maintainers” → “individual open-source maintainers”.
Addresses LanguageTool compound-adjective warning.
246-254: Heading level jump (MD001)Line 248 introduces an
#####(h5) heading after earlier h3/h4 levels, breaking logical nesting.Raise to
###or####, e.g.:-##### https://github.com/orgs/asyncapi/discussions/541#discussioncomment-5462792 +#### https://github.com/orgs/asyncapi/discussions/541#discussioncomment-5462792Apply to lines 248-253.
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (2)
1-1: Link to the generating script for traceabilityThe heading warns against manual edits but does not point to the exact script that produces the table. Adding the script’s relative path (or a link to it) makes troubleshooting & regeneration easier for contributors who stumble upon this file.
2-3: Minor wording & accessibility polish on header cells
- “GitHub user name” is more commonly written as “GitHub username” (see LanguageTool hint).
- Long camel-cased column titles such as
isVotedInLast3Monthsare hard to read; consider either snake-casing (voted_in_last_3_months) or adding spaces via<wbr>to improve wrapping.- Screen-reader users won’t benefit from emoji alone; adding an explicit legend below the table (e.g., “👍 = In favor, 👎 = Against, 👀 = Abstain, 🔕 = Did not participate”) improves accessibility.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (59)
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/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/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 (19)
📓 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: 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/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: 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/contribution-flow.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: 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/000-onboarding/docs-onboarding-checklist.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
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/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/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/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/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/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/010-contribution-guidelines/contribute-blog-post.md (4)
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: 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: 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/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/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/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/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/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/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/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/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.
🪛 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/summerofcode/mentors-guideline.md
[style] ~13-~13: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...communication is also essential. You'll need to communicate effectively with your contr...
(REP_NEED_TO_VB)
[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/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/asyncapi-mentorship/2022/README.md
[uncategorized] ~18-~18: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...e, and at-most-once, at-least-once, and exactly-once semantics](https://github.com/asyncapi/...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
markdown/docs/community/060-meetings-and-communication/slack-etiquette.md
[uncategorized] ~1-~1: You might be missing the article “the” here.
Context: AsyncAPI Community uses Slack for real-time conv...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...` is mentioned in the message. For more details read [this article](https://slack.com/i...
(AI_HYDRA_LEO_MISSING_COMMA)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
[misspelling] ~9-~9: Make sure that ‘the one of’ is correct and that ‘one’ is a pronoun. Possibly, the ‘the’ is unnecessary or ‘of’ is better expressed with a preposition such as ‘about’ or ‘in’.
Context: ...asyncapi/glee) | @fmvilas | AMQP 1.0 is the one of the most used protocols in big corporat...
(THE_ONE_OF_DT)
[typographical] ~13-~13: Consider adding a comma after this introductory phrase.
Context: ...AsyncAPI files to test against and as a result you get basic testing environment for s...
(AS_A_NN_COMMA)
[uncategorized] ~13-~13: You might be missing the article “a” here.
Context: ...to test against and as a result you get basic testing environment for specified broke...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...rotocol. 7 | [Rewrite this template and NodeJS WS template to new react rendering engi...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...asyncapi/nodejs-template/issues/133) | [NodeJS Template](https://github.com/asyncapi/n...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...thub.com/asyncapi/nodejs-template) and [NodeJS WS Template](https://github.com/asyncap...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...t. We need to rewrite existing Nunjucks Nodejs templates to React, so we finally can d...
(NODE_JS)
[uncategorized] ~14-~14: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...njucks Nodejs templates to React, so we finally can do React a default engine, and add more...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[grammar] ~15-~15: Did you mean “building”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...yncAPI. The project itself should allow to build AsyncAPI documentation from scratch, up...
(ALLOW_TO)
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...ation from scratch, update the existing one or just visualize the specification wit...
(AI_HYDRA_LEO_MISSING_COMMA)
[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)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...t makes the tool more discoverable, and shareable and enables you to deep dive into what ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~20-~20: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... | We are an automation-driven community and we use GitHub Actions to automate lots ...
(COMMA_COMPOUND_SENTENCE)
[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)
[uncategorized] ~20-~20: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ization. GitHub actions aren't unlimited and we need to have a clear picture of what...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~20-~20: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...icture of what workflows are using what amount of resources and how we can get the mos...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~21-~21: You might be missing the article “an” here.
Context: ...es, as it is always better to first add extension, check it on production and then turn i...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[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)
[uncategorized] ~22-~22: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... doing a great job at Glee and Generator and it's about the get even better. However...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ...cAPI tools are not properly promoted on AsyncAPI Website. Goal here is to improve discov...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~25-~25: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...e, and at-most-once, at-least-once, and exactly-once semantics](https://github.com/asyncapi/...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[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)
[uncategorized] ~26-~26: You might be missing the article “a” here.
Context: ...rocesses on GitHub. But there are still few more things to do in org like ours: </b...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~26-~26: You might be missing the article “an” here.
Context: ...here are still few more things to do in org like ours:
- we need to be able to...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[style] ~26-~26: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...them in a list of TSC members
- we need to communicate changes in automated way, t...
(REP_NEED_TO_VB)
[uncategorized] ~26-~26: You might be missing the article “an” here.
Context: .../br>- we need to communicate changes in automated way, twitter/email, as there is no one ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md
[inconsistency] ~12-~12: The suffix does not match the ordinal number.
Context: ...cation and Student registration starts: 23th January - Promos about WOC, Proposals a...
(ORDINAL_NUMBER_SUFFIX)
[grammar] ~31-~31: Before the countable noun ‘of’ an article or a possessive pronoun is necessary.
Context: ... | @AceTheCreator 5 | [update url of studio after making changes](https://github.co...
(IN_NN_CC_VBG)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: .../master/README.md#contributors). We use [All Contributors](https://allcontributor...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~9-~9: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...lack-invite) or some other channel. You come up with the idea that we used to do som...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[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)
[uncategorized] ~21-~21: Possible missing article found.
Context: ...To recognize work, after it is done, in closed issue or pull request, add a proper com...
(AI_HYDRA_LEO_MISSING_A)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
[uncategorized] ~18-~18: The official spelling of this programming framework is “Node.js”.
Context: ...umar)| | 5 | [Rewrite this template and NodeJS WS template](https://github.com/asyncap...
(NODE_JS)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
[uncategorized] ~18-~18: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...In 2022, GSoD at AsyncAPI had 2 projects and we hired 6 Technical Writers (TW). The...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~22-~22: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ch new TW contributor started. - June - August: Each TW went through designate...
(DASH_RULE)
[typographical] ~23-~23: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...issues assigned/selected. - September - October: We determined if we could com...
(DASH_RULE)
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md
[uncategorized] ~68-~68: Possible missing preposition found.
Context: ...50 Hours ## Contact AsyncAPI Mentors - Join [our Slack workspace](https://www.async...
(AI_HYDRA_LEO_MISSING_TO)
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md
[grammar] ~11-~11: Did you mean the verb “finds”?
Context: ...yncAPI. ## Your First Contribution ### Find Something to Work On The first step in ...
(SENT_START_PRPS_JJ_NN_VBP)
[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/ambassador-program/AMBASSADOR_PROGRAM.md
[grammar] ~26-~26: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ntribution. Some clarifications on the type of contributions: - Articles, videos, and podcasts ...
(TYPE_OF_PLURAL)
[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)
[uncategorized] ~37-~37: You might be missing the article “an” here.
Context: ... whole year. 3. If you were accepted as ambassador on the 5th of May 2022, you have alread...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[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)
[uncategorized] ~59-~59: You might be missing the article “a” here.
Context: ...https://api.github.com/users/ to form link similar to https://api.github.com/users...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~61-~61: Possible missing article found.
Context: ... The API returns a JSON object in which property id equals a number (in the case of th...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~64-~64: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...e Ambassador Candidate finds themselves in the members list of the Slack channel `...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[uncategorized] ~65-~65: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...nnel 02_general. > - Presses on their handle. > - In the opened Profile window, pr...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
markdown/docs/community/010-contribution-guidelines/git-workflow.md
[uncategorized] ~50-~50: Possible missing comma found.
Context: ...y to understand all the steps. > > Next time you can write a script to synchronize m...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ...e you can write a script to synchronize master branch of your fork with the master bra...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ... of your fork with the master branch of upstream git repository. Check [this script](htt...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md
[uncategorized] ~19-~19: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...how trait concepts work. - Organizing document with tags - Explain different tags in...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~21-~21: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...rver, or channel or message, to specify thing that are common only for given protocol...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[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/010-contribution-guidelines/Become-maintainer-in-existing-project.md
[typographical] ~43-~43: After the expression ‘for example’ a comma is usually used.
Context: ... you are sponsored by some company. For example [see this PR that introduced one of the...
(COMMA_FOR_EXAMPLE)
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md
[typographical] ~13-~13: Consider adding a comma here.
Context: ...m maintainers. # Blog post requirements Please observe the following requirements for ...
(PLEASE_COMMA)
markdown/docs/community/040-guides/keep-repository-settings-consistent.md
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...: - Wikis - Projects Make sure Sponsorships option is selected and `...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~29-~29: This verb does not appear to agree with the subject. Consider using a different form.
Context: .../.github/tree/master/.github/workflows) cover mostly all the needs for most of the re...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md
[typographical] ~8-~8: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...oC Organizations announced - February 22 - March 20: Potential GSoC contributors di...
(DASH_RULE)
[typographical] ~9-~9: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ... with mentoring organizations - March 20 - April 4: GSoC contributor application pe...
(DASH_RULE)
[typographical] ~10-~10: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ... contributor application period - May 17 - June 7: Accepted GSoC Contributor projec...
(DASH_RULE)
[typographical] ~12-~12: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ogle Summer of Code projects - August 28 - September 4: Mentors submit final GSoC c...
(DASH_RULE)
[grammar] ~20-~20: The usual collocation for technology is “on”, not “in”.
Context: ...3 | [Introduce UI tests and refactoring in the website: Website](https://github.com/asyncapi/w...
(IN_THE_INTERNET)
[uncategorized] ~43-~43: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...dium Expected Time Commitment: 175 Hour Technical skills requried Typescr...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~47-~47: The official spelling of this programming framework is “Node.js”.
Context: ...echnical skills requried** Typescript, nodejs, websocket, EDA basics ## 2) Automate...
(NODE_JS)
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ... ## 2) Automate listing of members of technical steering committee: Community Our [ope...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~52-~52: You might be missing the article “the” here.
Context: ...nt to use their right to have a vote in TSC decisions making process. We need a bo...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~52-~52: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...o use their right to have a vote in TSC decisions making process. We need a bot/github a...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~54-~54: You might be missing the article “a” here.
Context: ...d VOTERS files from all repos, maintain single list, and put it on the website Descri...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[grammar] ~56-~56: There seems to be a noun/verb agreement error. Did you mean “gets” or “got”?
Context: ... and put it on the website Description get a github action that reacts on any push...
(SINGULAR_NOUN_VERB_AGREEMENT)
[uncategorized] ~57-~57: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...ts on any push to master and checkes if voters file was edited. Then reads it and add/...
(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
[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)
[uncategorized] ~74-~74: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...dium Expected Time Commitment: 175 Hour ## 3) Introduce UI tests and refactori...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[grammar] ~76-~76: The usual collocation for technology is “on”, not “in”.
Context: ...# 3) Introduce UI tests and refactoring in the website: Website We need automation tests to r...
(IN_THE_INTERNET)
[uncategorized] ~78-~78: The preposition “of” seems more likely in this position.
Context: ... tests, but also to refactor some parts in code to effectively create tests on it....
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~88-~88: Possible missing comma found.
Context: ...ded to the repository - no tests, means nothing forces us to write clearer and testable...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~89-~89: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ution will become hard as more and more addition of code will make Duplication and incon...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~105-~105: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...dium Expected Time Commitment: 175 Hour ## 4) Add "Autofix" feature for commo...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~131-~131: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...dium Expected Time Commitment: 175 Hour ## 5) AsyncAPI: Add help/{command} end...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[typographical] ~137-~137: After the expression ‘for example’ a comma is usually used.
Context: ...ction of given command to the user. For example help/generate should return available...
(COMMA_FOR_EXAMPLE)
[style] ~141-~141: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... with other endpoint(s). Also, what is very important, that endpoint should be done in a simi...
(EN_WEAK_ADJECTIVE)
[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)
[uncategorized] ~141-~141: You might be missing the article “the” here.
Context: ...tps://github.com/asyncapi/cli#usage, so main help endpoint should return all availab...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~155-~155: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...dium Expected Time Commitment: 175 Hour
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md
[uncategorized] ~32-~32: Possible missing comma found.
Context: ... links to a sample of code unrelated to AsyncAPI demonstrating your development abilitie...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~39-~39: The usual collocation for “independently” is “of”, not “from”. Did you mean “independently of”?
Context: ...untary or commercial) to AsyncAPI users independently from the official AsyncAPI project? - If you...
(INDEPENDENTLY_FROM_OF)
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md
[typographical] ~7-~7: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...oC Organizations announced - February 22 - March 18: Potential GSoC contributors di...
(DASH_RULE)
[typographical] ~11-~11: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...C Contributor projects announced - May 1 - 26: Community Bonding Period | GSoC cont...
(DASH_RULE)
[typographical] ~15-~15: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...dline (standard coding period) - July 12 - August 19: Work Period | GSoC contributo...
(DASH_RULE)
[typographical] ~16-~16: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...t with guidance from Mentors - August 19 - 26: Final week: GSoC contributors submit...
(DASH_RULE)
[typographical] ~17-~17: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ion (standard coding period) - August 26 - September 2: Mentors submit final GSoC c...
(DASH_RULE)
[typographical] ~19-~19: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...mer of Code 2024 announced - September 3 - November 4: GSoC contributors with exten...
(DASH_RULE)
[duplication] ~29-~29: Possible typo: you repeated a word.
Context: ...intu Gogoi](https://github.com/Gmin2), Yuan Yuan | | 4 | [M...
(ENGLISH_WORD_REPEAT_RULE)
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)
[formatting] ~11-~11: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...uetzalli) |Community uses diff protocols, because everyone has diverse needs. To get more...
(COMMA_BEFORE_BECAUSE)
[uncategorized] ~12-~12: The official spelling of this programming framework is “Node.js”.
Context: ...setups. 5 | [Rewrite this template and NodeJS WS template](https://github.com/asyncap...
(NODE_JS)
[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/COC-incident-resolution-procedures.md
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...F_CONDUCT.md) in writing or in a spoken conversation as indicated below.
Submit in wr...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~97-~97: Possible missing comma found.
Context: ... been received concerning their alleged behavior unless it determines that the report is...
(AI_HYDRA_LEO_MISSING_COMMA)
[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)
[typographical] ~127-~127: Consider adding a comma.
Context: ...onduct). If the CoC Committee determines there are any such systemic issues, the CoC C...
(IF_THERE_COMMA)
[uncategorized] ~133-~133: You might be missing the article “a” here.
Context: ...armful behavior an isolated incident or pattern of repeated behavior?
- How se...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~167-~167: This verb does not appear to agree with the subject. Consider using a different form.
Context: ... a non-violent communication course and fail to do so), the CoC Committee may take f...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~171-~171: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...determined that the CoC was not violated and no remediation is needed. When the inci...
(COMMA_COMPOUND_SENTENCE_2)
[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)
[uncategorized] ~240-~240: Possible missing comma found.
Context: ...interest will not have the right to vote but may be allowed to participate in a disc...
(AI_HYDRA_LEO_MISSING_COMMA)
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)
[style] ~28-~28: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... quorum of the non-conflicted members. A majority of non-conflicted members shall be deemed ...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
markdown/docs/community/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)
[uncategorized] ~62-~62: The official spelling of this programming framework is “Node.js”.
Context: ... - 🛠️ Skills Required: Typescript, Node js, Jest, Github actions - 🧩 **Difficulty...
(NODE_JS)
[uncategorized] ~71-~71: The official spelling of this programming framework is “Node.js”.
Context: ... - 🛠️ Skills Required: Typescript, Node js, E2E Testing, Github actions - 🧩 **Dif...
(NODE_JS)
[uncategorized] ~80-~80: The official spelling of this programming framework is “Node.js”.
Context: ... - 🛠️ Skills Required: Typescript, Node js, Figma, TailwindCSS - 🧩 **Difficulty:*...
(NODE_JS)
[uncategorized] ~86-~86: Possible missing preposition found.
Context: ...50 hours ## Contact AsyncAPI Mentors - Join [our Slack workspace](https://www.async...
(AI_HYDRA_LEO_MISSING_TO)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
[uncategorized] ~4-~4: You might be missing the article “the” here.
Context: ...port AsyncAPI Initiative ### Overview AsyncAPI Initiative is dedicated to advancing Ev...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~40-~40: You might be missing the article “the” here.
Context: ...ployees to contribute to projects under AsyncAPI Initiative on a regular basis, and we'l...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[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)
[uncategorized] ~47-~47: You might be missing the article “the” here.
Context: ...ovided venue. ##### Service provision AsyncAPI Initiative relies on numerous tools, ma...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~64-~64: Possible missing article found.
Context: ...ds of our growing community, we require full-time commitment. With the help of Open ...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~64-~64: You might be missing the article “the” here.
Context: ...ive, we can hire individuals to work on AsyncAPI Initiative. We recently welcomed [Thuli...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~84-~84: A comma might be missing here.
Context: ...## Success Stories Thanks to financial support we can already see many success stories...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~88-~88: You might be missing the article “a” here.
Context: ...ommunity Manager As a result of hiring dedicated Community Manager we now have a regular...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~88-~88: A comma might be missing here.
Context: ... a result of hiring dedicated Community Manager we now have a regular monthly newslette...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~99-~99: Possible missing comma found.
Context: ...t attracts many participants. Only last year the conference generated [3k views](htt...
(AI_HYDRA_LEO_MISSING_COMMA)
[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)
[uncategorized] ~108-~108: You might be missing the article “an” here.
Context: ...ding to the project as a sponsor. Write email to info@asyncapi.io.
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
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)
[uncategorized] ~22-~22: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... with 👀 to indicate that you saw a vote but you have no opinion, or cannot make a p...
(COMMA_COMPOUND_SENTENCE)
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)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...ts in the organization by visiting our GitHub org. - Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[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/050-mentorship-program/seasonofdocs/2023/README.md
[uncategorized] ~20-~20: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...how trait concepts work. - Organizing document with tags - Explain different tags in...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[typographical] ~44-~44: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...ine The project will take approximately 4-6 months to complete, depending on the di...
(HYPHEN_TO_EN)
[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] ~48-~48: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ch new TW contributor started. - June - August: Each TW goes through designate...
(DASH_RULE)
[typographical] ~49-~49: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...issues assigned/selected. - September - October: We determine if we can comple...
(DASH_RULE)
[typographical] ~54-~54: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... ### 💸 Project budget We'll set aside 2-3 mentors for our two proposed projects: ...
(HYPHEN_TO_EN)
[uncategorized] ~54-~54: If this is a question, use a question mark.
Context: ...oogle a US $5000 budget for each project. For both projects, the request then tot...
(QUESTION_MARK)
[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/020-governance-and-policies/donating-projects.md
[uncategorized] ~4-~4: You might be missing the article “the” here.
Context: ...ligns it with broader community goals. AsyncAPI initiative is open to receiving project...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[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)
[formatting] ~38-~38: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...grating your project to the organization, because the Technical Steering Committee (TSC) ...
(COMMA_BEFORE_BECAUSE)
[grammar] ~48-~48: If the situation that you’re describing is mandatory or essential, you can use the subjunctive mood here.
Context: ..., it's essential that the documentation reflects these changes accurately to assist both...
(SUBJUNCTIVE_MOOD)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...butors that are not affiliated with any company willing to help the AsyncAPI Initiative...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~47-~47: If the word ‘do’ starts a question (or is part of a question), add a question mark (“?”) at the end of the sentence.
Context: ...on why do we want to be that transparent. ## Duties TSC members have two primar...
(PCT_DO_QUESTION_MARK)
[uncategorized] ~52-~52: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...s have two primary duties: 1. Regularly participate in TSC discussions and voting. 2. Alway...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[style] ~53-~53: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...iscussions and voting. 2. Always behave with respect to [AsyncAPI Code of Conduct](https://gith...
(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
[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)
[style] ~58-~58: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ts to join the AsyncAPI umbrella (owner wants to donate the project to the AsyncAPI Init...
(REP_WANT_TO_VB)
[uncategorized] ~82-~82: The preposition ‘to’ seems more likely in this position.
Context: ...e else. * TSC members are first asked for help with the Master ceremony, exposing...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[uncategorized] ~88-~88: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the most trusted group in the community and it is the first group of people to choo...
(COMMA_COMPOUND_SENTENCE)
markdown/docs/community/onboarding-guide/github-actions.md
[uncategorized] ~49-~49: A punctuation mark might be missing here.
Context: ...bal GitHub Actions workflows inside the [.github](https://github.com/asyncapi/....
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~74-~74: The official spelling of this programming framework is “Node.js”.
Context: ...ften uses GitHub Topics (like golang, nodejs, or docker) to decide which reposito...
(NODE_JS)
[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/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/introduction-of-changes-to-spec.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...ou already have a solution in mind to a problem instead of fully diving into the issue,...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~5-~5: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...finding the best solution. ### RFCs & champions Some changes, however, are "substantial...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ...champions to explore the idea, document it and create a proposal for bringing it t...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~21-~21: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...st before submitting the Change proposal so the community can evaluate the change. ...
(COMMA_COMPOUND_SENTENCE_2)
[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/README.md
[uncategorized] ~30-~30: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... - "Final Project Material" means a Participants final source code/design file and assoc...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[grammar] ~85-~85: Probably a preposition is missing after ‘Apply’.
Context: ...pated in the Program once. #### How To Apply Ensure you're eligible to participate in the P...
(ATD_VERBS_TO_COLLOCATION)
[grammar] ~88-~88: This phrase is duplicated. You should probably use “Project Proposals” only once.
Context: ...escribed in the Program Timeline. #### Project Proposals - Project Proposals must be for Projects on the Organizatio...
(PHRASE_REPETITION)
[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)
[uncategorized] ~113-~113: Possible missing preposition found.
Context: ...ram Participation #### Evaluations - Multiple Mentors: If a Participant has more th...
(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~129-~129: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... All participants will receive an equal amount of stipends during the program particip...
(AMOUNTOF_TO_NUMBEROF)
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)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...mbassadors. The TSC may adopt or modify roles so long as the roles are documented in ...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~49-~49: This word is normally spelled as one.
Context: ...cubation, deprecation, and changes to a sub-project’s scope); 3. Organizing sub-project...
(EN_COMPOUNDS_SUB_PROJECT)
[misspelling] ~50-~50: This word is normally spelled as one.
Context: ...sub-project’s scope); 3. Organizing sub-projects and removing sub-projects; 4. Creat...
(EN_COMPOUNDS_SUB_PROJECTS)
[misspelling] ~50-~50: This word is normally spelled as one.
Context: ...3. Organizing sub-projects and removing sub-projects; 4. Creating sub-committees or work...
(EN_COMPOUNDS_SUB_PROJECTS)
[misspelling] ~51-~51: This word is normally spelled as one.
Context: ... removing sub-projects; 4. Creating sub-committees or working groups to focus on cross-pro...
(EN_COMPOUNDS_SUB_COMMITTEES)
[typographical] ~56-~56: Conjunctions like ‘and’ should not follow semicolons. Consider using a comma, or removing the conjunction.
Context: ... code base that affect multiple projects; and 10. Coordinating any marketing, events, or...
(CONJUNCTION_AFTER_SEMICOLON)
[uncategorized] ~63-~63: You might be missing the article “a” here.
Context: ...t. 3. The Board members are elected for 24-month cadence. 4. The Board members MUST be T...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[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)
[uncategorized] ~69-~69: You might be missing the article “the” here.
Context: ...t. 9. The Board chairperson coordinates work of the board and ensures it operates ef...
(AI_EN_LECTOR_MISSING_DETERMINER_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] ~101-~101: You might be missing the article “a” here.
Context: ... will be conducted without the need for quorum, and only two-thirds of the votes will ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[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: Nowadays, it’s more common to write this as one word.
Context: ...cy, as to be amended or adopted, on its web site at least 30 days prior to such policy t...
(RECOMMENDED_COMPOUNDS)
[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] ~120-~120: Nowadays, it’s more common to write this as one word.
Context: ...ective upon publication on LF Project’s web site. 4. All Collaborators must allow open p...
(RECOMMENDED_COMPOUNDS)
[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/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)
[style] ~24-~24: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...members, and anything the Working Group wants to include. ### How to reach out to a Wor...
(REP_WANT_TO_VB)
[grammar] ~32-~32: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...(../../WORKING_GROUPS.yaml) file in the slack.channel.handle field. Example: `#wg-de...
(ON_SKYPE)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s its main purpose rewarding individual open source maintainers and contributors of **Middl...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[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)
[uncategorized] ~98-~98: Possible missing comma found.
Context: ...gram is counted from Monday of the next week when assignment of the Bounty Issue on ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~106-~106: Possible missing article found.
Context: ...and the start of its merging process - Final Pull Request must be submitted, and its...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~112-~112: Possible missing article found.
Context: ...and the start of its merging process - Final Pull Request must be submitted, and its...
(AI_HYDRA_LEO_MISSING_A)
[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)
[uncategorized] ~124-~124: Commas should not be placed before a closing parenthesis. Either move the comma outside of the parentheses, or remove it altogether.
Context: ...vity of any type was on 2024-05-16 or earlier,) they are pinged as a reminder to do so....
(COMMA_CLOSING_PARENTHESIS)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...ules are applied to such Bounty Program Participants and the End Of Life rules to such Bount...
(AI_HYDRA_LEO_MISSING_COMMA)
[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)
[uncategorized] ~159-~159: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...as already acquired an obligation to pay but factually the conditions of the Bounty ...
(COMMA_COMPOUND_SENTENCE_2)
[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)
[uncategorized] ~188-~188: Possible missing article found.
Context: ...Bounty Issues submitted by themselves. Bounty Program Participant is allowed to choos...
(AI_HYDRA_LEO_MISSING_A)
[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] ~196-~196: You might be missing the article “the” here.
Context: ...ub label bounty to the GitHub issue. GitHub label bounty has hex code #0E8A16. ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[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)
[uncategorized] ~218-~218: Commas should not be placed before a closing parenthesis. Either move the comma outside of the parentheses, or remove it altogether.
Context: ...scal Host in the US (AsyncAPI fits this description,) they will be asked to fill out an IRS t...
(COMMA_CLOSING_PARENTHESIS)
[uncategorized] ~220-~220: Possible missing article found.
Context: ...In rare cases (once per calendar year), Bounty Program Participant in personal communi...
(AI_HYDRA_LEO_MISSING_A)
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...t. The main purpose of such a tool is a changelog where you can present to the user what ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ..., but not as pointing what lines changed but in general what objects changed. So if ...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~24-~24: Consider adding a comma after this introductory phrase.
Context: ...t as pointing what lines changed but in general what objects changed. So if there was a...
(IN_GENERAL_COMMA)
[uncategorized] ~24-~24: You might be missing the article “the” here.
Context: ...s changed. So if there was an update in payload, the library must specify what channel ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ... in what message got updated (with json pointers most probably). You can familiarize wit...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~25-~25: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ions. We already started work on the CLI so before summer there will be enough to p...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~42-~42: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ject. We already started work on the CLI so before summer there will be enough to p...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~56-~56: You might be missing the article “a” here.
Context: ...ve to first onboard on the project with few basic tasks handed over by the mentor. ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~62-~62: Possible missing comma found.
Context: ...expert. Based on a set of questions and answers it should generate an AsyncAPI document...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...r the user. Example conversation: (real-time we show a preview of the AsyncAPI docum...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~76-~76: ‘a’ may be redundant when used with the uncountable noun ‘knowledge’.
Context: ...edge: This project requires you to have a basic knowledge about the location of spec related mate...
(A_UNCOUNTABLE_NOUN)
[uncategorized] ~76-~76: A comma might be missing here.
Context: ...what is missing to make it possible. As prerequisite you of course need to read about curren...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~76-~76: Consider adding two commas here.
Context: ...to make it possible. As prerequisite you of course need to read about current technologies...
(OF_COURSE_COMMA)
[style] ~76-~76: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...possible. As prerequisite you of course need to read about current technologies that ar...
(REP_NEED_TO_VB)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ...up environments with Docker compose and mocks and a proper testing environment will h...
(AI_HYDRA_LEO_MISSING_COMMA)
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] ~53-~53: There may an error in the verb form ‘be inform’.
Context: ...y, in-depth video tutorials. This could be inform of the Bounty Program.
- Online Le...
(MD_BE_NON_VBP)
[uncategorized] ~84-~84: Possible missing article found.
Context: ...ubscription and participation - Publish marketing blog every quater detailing the activit...
(AI_HYDRA_LEO_MISSING_A)
[style] ~102-~102: This phrase is redundant (‘O’ stands for ‘Optimization’). Use simply “SEO”.
Context: ... | ## Website Traffic Growth ### SEO Optimization - Improve AsyncAPI website SEO with hi...
(ACRONYM_TAUTOLOGY)
[uncategorized] ~136-~136: You might be missing the article “the” here.
Context: ...ewsletter", linking to subscribe. - Ask community to promote the newsletter to their audi...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~156-~156: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... | The views per month, and the new subscriber. 20% increase quarter | | **Website Tra...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...tly to render your tool on the AsyncAPI website with customized tags and information fo...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~16-~16: You might be missing the article “the” here.
Context: ...ate 2 or more .asyncapi-tool files in same repository, you can do the same, just m...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~16-~16: You might be missing the article “the” here.
Context: ...do the same, just make sure you provide correct repoUrl for each of them. Same case a...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~16-~16: A determiner appears to be missing. Consider inserting it.
Context: ...ide correct repoUrl for each of them. Same case applies for monorepo as well. ## ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~70-~70: You might be missing the article “the” here.
Context: ...-tool file is located. You can override default behaviour in cases when you have multip...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~74-~74: The auxiliary verb ‘do’ requires the base form of the verb.
Context: ...e proper category. If your tool doesn't matches with any categories specified in list, ...
(DID_BASEFORM)
[uncategorized] ~74-~74: You might be missing the article “the” here.
Context: ...atches with any categories specified in list, you can choose others option to list...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~74-~74: You might be missing the article “the” here.
Context: ...ories specified in list, you can choose others option to list your tool. | Y...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~77-~77: It appears that an article is missing.
Context: ...yncapi-tool` file to render the tool in website. This is example of [AsyncAPI Bundler](...
(IN_WEBSITE)
[uncategorized] ~77-~77: You might be missing the article “an” here.
Context: ... to render the tool in website. This is example of [AsyncAPI Bundler](https://github.co...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[typographical] ~137-~137: A comma before “as well” is not needed unless you want to explicitly mark a pause in speech.
Context: ...ols-manual.json) with proper json schema, as well. ```JSON "Sample category na...
(AS_WELL_UNNECESSARY_COMMA)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[grammar] ~27-~27: After the singular determiner ‘another’, use a singular noun. Did you mean “event”?
Context: ...nother GitHub Actions outage and proper events are not delivered to automation :smiley...
(ANOTHER_NNS)
[misspelling] ~28-~28: This expression is normally spelled as one or with a hyphen.
Context: ...t is, by default, configured to support live streaming 1. It creates a GitHub issue with all d...
(EN_COMPOUNDS_LIVE_STREAMING)
[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)
[uncategorized] ~197-~197: Possible missing comma found.
Context: ...//www.youtube.com/watch?v=3rg_7hIb9PQ. Here the video ID is the word/entity after `...
(AI_HYDRA_LEO_MISSING_COMMA)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
[misspelling] ~10-~10: Did you mean “ensuring their”?
Context: ... designing digital badges for AsyncAPI, ensuring they’re visually appealing and fit within our b...
(VBG_THEYRE)
[uncategorized] ~20-~20: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...cal AsyncAPI file with a remote system (e.g registry). Publish my AsyncAPI file in ...
(E_G)
[uncategorized] ~23-~23: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ally low numbers in both web and mobile view, which can impact the efficiency and us...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[grammar] ~23-~23: The usual collocation for technology is “on”, not “in”.
Context: ...an impact the efficiency and user views in the website. On the other hand, it's also important...
(IN_THE_INTERNET)
[uncategorized] ~24-~24: The official spelling of this programming framework is “Next.js”.
Context: ...packages, as we migrated the website to Next js 14 + Typescript, it has now started aff...
(NODE_JS)
[uncategorized] ~24-~24: The official spelling of this programming framework is “Node.js”.
Context: ...ite, we decided to migrate the existing Node js scripts to common js modules (in Typesc...
(NODE_JS)
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...other product designers looking to make open source contributions or to maybe gain experien...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~26-~26: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...s to recognize member contributions and creating a vibrant, active community with Holopi...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~29-~29: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...round to try out the spec and becomes a fully-featured suite to help developers work with even...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h5
(MD001, heading-increment)
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/2022/project-ideas.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.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/050-mentorship-program/asyncapi-mentorship/2023/README.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
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/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/010-contribution-guidelines/Become-maintainer-in-existing-project.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)
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/040-guides/keep-repository-settings-consistent.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)
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md
2-2: Bare URL used
(MD034, no-bare-urls)
16-16: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
34-34: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
62-62: Bare URL used
(MD034, no-bare-urls)
68-68: Bare URL used
(MD034, no-bare-urls)
92-92: Bare URL used
(MD034, no-bare-urls)
99-99: Bare URL used
(MD034, no-bare-urls)
114-114: Bare URL used
(MD034, no-bare-urls)
114-114: Bare URL used
(MD034, no-bare-urls)
114-114: Bare URL used
(MD034, no-bare-urls)
117-117: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
125-125: Bare URL used
(MD034, no-bare-urls)
135-135: Bare URL used
(MD034, no-bare-urls)
141-141: Bare URL used
(MD034, no-bare-urls)
143-143: Bare URL used
(MD034, no-bare-urls)
149-149: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/application-template.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/summerofcode/2024/README.md
25-25: 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/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/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/050-mentorship-program/summerofcode/README.md
7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
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/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/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/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)
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
2-2: Bare URL used
(MD034, no-bare-urls)
16-16: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
34-34: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
62-62: Bare URL used
(MD034, no-bare-urls)
68-68: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
66-66: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
67-67: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
74-74: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
81-81: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
82-82: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
83-83: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
132-132: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
138-138: Headings must start at the beginning of the line
(MD023, heading-start-left)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
24-24: Bare URL used
(MD034, no-bare-urls)
25-25: Bare URL used
(MD034, no-bare-urls)
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/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
15-15: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
15-15: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
15-15: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
16-16: Multiple headings with the same content
(MD024, no-duplicate-heading)
18-18: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
19-19: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
20-20: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
21-21: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
22-22: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
23-23: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
24-24: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
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)
⏰ Context from checks skipped due to timeout of 180000ms (4)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Lighthouse CI
🔇 Additional comments (19)
markdown/docs/community/011-styleguide/numbers.md (1)
158-159: Whitespace fix looks good
The removal of the stray leading space before3:15 PM (UTC)brings the example in line with the preceding one and eliminates an unnecessary indentation artifact.markdown/docs/community/011-styleguide/grammar.md (1)
75-76: List-item bullet formatting corrected
Dropping the extra hyphen before the Microsoft Style Guide link restores a clean, single-level list. No further action required.markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
47-47: No action needed
The only change is removal of a trailing newline; content is unaffected.markdown/docs/community/community-glossary.md (1)
1-3: Consider adding minimum context before publishing
Publishing a bare “🚧 under construction” page may be confusing for users following internal links. Even a short outline (e.g., planned sections or a definition stating the page purpose) can help set expectations.markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
101-101: Formatting tweak looks goodThe stray “-” was removed and the list renders correctly; no further action needed.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
15-16: Double-check that the new relative paths resolve
../010-contribution-guidelines/technical-writer-contributor-responsibilities
../010-contribution-guidelines/prerequisite-knowledgeIf the generator expects
.mdextensions or trailing slashes, these links could 404. Please build locally or run the link-check CI job to ensure they resolve.markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
17-18: Verify default branch nameThe guide refers to merging into the
masterbranch. Many AsyncAPI repositories now usemain. Please double-check repository defaults before merging this doc.markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (1)
30-34: Table column mismatchThe TOTAL row only supplies two cells while the header defines two columns, but earlier rows visually appear as three due to spacing. Ensure the markdown table renders consistently by matching column count.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)
20-21: Mismatched GitHub handle for mentee.Row 7 shows mentee “Milan D Vijay” but links to
https://github.com/ibishal, which is the mentor’s profile. Verify and update the hyperlink.markdown/docs/community/050-mentorship-program/README.md (1)
18-26: Verify external links.
[AsyncAPI Mentorship](https://www.asyncapi.com/)points to the main website, not the mentorship landing page. Confirm that this is intentional; otherwise, link to the specific mentorship docs page.markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (1)
30-30: Duplicate word “Yuan Yuan”.If the contributor’s first and last names are identical, ignore; otherwise confirm and correct the repetition.
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
67-70: Missing preposition in the Slack bullet“Join our Slack workspace” is fine, but the static checker complains because the phrase originally lacked “to”. If you keep the imperative style, ignore the tool; if you prefer the infinitive, rewrite as “Join our Slack workspace to…”.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)
20-27: Numerous LanguageTool warningsExamples:
- “e.g registry” → “e.g. registry”
- “Next js” / “Node js” → “Next.js” / “Node.js”
- “creating a vibrant” (verb agreement)
Consider running the file through a spellchecker to catch these minor yet numerous slips.
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (1)
28-38: Local image links point to user-attachments; they will break on the websiteThe three screenshot links reference
github.com/user-attachments/...which are only available in the PR comment context.
Host the images in the repository (e.g.,/assets/img/...) or an AsyncAPI-owned CDN so the docs site can render them.markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
37-46: Anchor mismatch: list slug vs heading text
The TOC entry links to#why-the-tsc-was-formedbut the actual heading is “## Why the TSC was formed” (missing “was” in slug). Many Markdown processors generate slugs automatically; verify the link works after the site build.markdown/docs/community/020-governance-and-policies/CHARTER.md (1)
93-96: Confirm GOVERNANCE file actually documents quorum rules
The Charter defers to a GOVERNANCE file for quorum details. Ensure that file exists in this PR; otherwise add a TODO so the reference isn’t broken.markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (1)
138-157: Metrics table wording & grammar.Line 156: “The views per month, and the new subscriber” is awkward and singular/plural mismatched. Suggest:
-"The views per month, and the new subscriber." +"Monthly views and new subscribers."markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
18-25: Minor punctuation & commas.Sentences run long; add commas after introductory clauses (“In general, …”) to improve readability.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (1)
88-88: Add article & comma.“As a result of hiring a dedicated Community Manager, we now have …”
| 🚧 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.
💡 Verification agent
❓ Verification inconclusive
Missing front-matter may break site build and navigation
All other community docs include a YAML front-matter block (title, description, weight, …). Without it the build-time loaders may:
- Treat the page as “orphan” (no title in menus / search),
- Fail if front-matter is mandatory in the MDX/Hugo pipeline.
Add at least a minimal block or mark the file as draft to keep it off production navigation until content is ready.
+---
+title: 'Project Roadmap'
+description: '🚧 Placeholder – document under construction.'
+weight: 90 # pick whatever fits the section order
+draft: true # if the site generator supports it
+---
+
🚧 This document is under construction.
Please be patient as we work on it. Thank you. 🫶Verify whether the docs build passes without front-matter; if it does, ignore this suggestion, otherwise add the block.
Add YAML front-matter to ROADMAP.md
All other community docs include a front-matter block so they’re picked up correctly in menus and search. Without it, this page may be treated as an orphan or even fail the site build.
Please insert the following at the very top of markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md:
+---
+title: 'Project Roadmap'
+description: '🚧 Placeholder – document under construction.'
+weight: 90 # adjust to fit your section order
+draft: true # hides it from production navigation until ready
+---
+
🚧 This document is under construction.
Please be patient as we work on it. Thank you. 🫶- File affected:
• markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md
📝 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: 'Project Roadmap' | |
| description: '🚧 Placeholder – document under construction.' | |
| weight: 90 # adjust to fit your section order | |
| draft: true # hides it from production navigation until ready | |
| --- | |
| 🚧 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
very top (lines 1 to 3), add a YAML front-matter block consistent with other
community docs to ensure the page is included correctly in menus and search.
Insert the standard front-matter syntax with appropriate metadata before any
other content in the file.
| The AsyncAPI Code of Conduct Committee (CoC Committee) is a committee that responds to investigates, and resolves [AsyncAPI Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md) incidents. | ||
|
|
There was a problem hiding this comment.
Grammar: missing comma after “responds to”
Current text: “responds to investigates, and resolves …”.
It should read “responds to, investigates, and resolves …”.
🤖 Prompt for AI Agents
In markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md around lines 5 to 6, add
a comma after "responds to" in the sentence describing the committee's actions.
Change "responds to investigates, and resolves" to "responds to, investigates,
and resolves" to correct the grammar.
| Number | Idea | Area | Mentor/s| Scope | | ||
| :---:|:---:|:---:|:---:|:---:| | ||
| 1| [Enhancing Developer Experience in CLI](https://github.com/asyncapi/cli/issues/1508) | Coding | [Souvikns](https://github.com/Souvikns) | Improve the AsyncAPI CLI by adding features like validating files with custom rules, syncing with remote systems, publishing to schema registries, rendering documentation, and fixing test case execution. Also, address remaining DX issues in the CLI.| | ||
| 2| [Becoming a Maintainer of AsyncAPI Generator](https://github.com/asyncapi/generator) | Coding | [derberg](https://github.com/derberg) | Familiarize with the AsyncAPI Generator by setting it up locally, running tests, and improving the development guide. Complete the tutorial, provide documentation feedback, and demonstrate JavaScript skills. Previous contributions to AsyncAPI are a plus.| | ||
| 3| [Migration of build + workflow scripts to TypeScript](https://github.com/asyncapi/website/issues/3187) | Coding | [akshatnema](https://github.com/akshatnema) | Migrate existing Node.js scripts to TypeScript for improved code uniformity, scalability, and maintainability. This involves setting up ts-node without altering the current Node.js setup, converting build and workflow scripts to TypeScript, ensuring compatibility with GitHub workflows, and maintaining or expanding test coverage to ensure nothing breaks during the migration process. | | ||
| 4| [Holopin Design Project](https://github.com/asyncapi/community/issues/1306)| Design | [Mayaleeeee](https://github.com/Mayaleeeee) | In this project, you'll be designing digital badges for AsyncAPI, ensuring they’re visually appealing and fit within our branding. Familiarize yourself with Figma (or similar tools), grasp basic design principles, and understand branding.| | ||
| 5| [Onboarding Contributor Guides](https://github.com/asyncapi/generator) | Docs |[quetzalliwrites](https://github.com/quetzalliwrites) [wise4rmgod](https://github.com/wise4rmgod) [bandantonio](https://github.com/bandantonio) | The goal is to enhance the onboarding process by developing clear, structured, and automated guides, ensuring new contributors can efficiently integrate into the project. This will include written guides and media resources like YouTube videos to simplify the journey for each role. | | ||
| 6| [Path to Maintainership for the AsyncAPI React Project](https://github.com/asyncapi/asyncapi-react) | Coding | [AceTheCreator](https://github.com/AceTheCreator) | The AsyncAPI React component is essential for rendering and validating API documentation based on the AsyncAPI specification, with over 5 million downloads. This project aims to revitalize its development by onboarding a new maintainer to work on bug fixes, UX improvements, feature additions, issue triaging, and engaging contributors. The focus is on maintaining and improving the component while mentoring a passionate individual who is familiar with TypeScript, React, and open-source contributions | | ||
| 7| [Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin](https://github.com/asyncapi/vs-asyncapi-preview/issues/235) | Coding | [ivangsa](https://github.com/ivangsa) | Enhance the VS Code AsyncAPI[asyncapi/vs-asyncapi-preview](https://github.com/asyncapi/vs-asyncapi-preview/issues/235) Plugin by adding EDAVisualiser's[EDAVisualiser](https://github.com/asyncapi/EDAVisualiser) application focus view. This new feature will allow users to visualize how an application interacts with other defined applications. The project involves integrating the EDAVisualiser library, implementing a configuration system for related AsyncAPI documents, and creating a user interface to switch between preview modes. Skills required include JavaScript/TypeScript, VS Code extension development, and AsyncAPI knowledge. | | ||
| 8| [Expand AsyncAPI Community Docs](https://github.com/asyncapi/community/blob/master/docs/onboarding-guide/docs-onboarding-checklist.md) | Docs | [quetzalliwrites](https://github.com/quetzalliwrites) [wise4rmgod](https://github.com/wise4rmgod) [bandantonio](https://github.com/bandantonio) | This project focuses on enhancing the AsyncAPI community documentation by automating the onboarding process and documenting workflows for contributors, maintainers, ambassadors, and governance. The goal is to streamline contributions, encourage participation, and provide clear guidelines for various roles. The project involves documenting contribution flows, Git workflows, maintainership guidelines, and community health standards. The maintainership goal includes onboarding a dedicated docs triage to help manage and update these critical community processes.| | ||
| ======= |
There was a problem hiding this comment.
Unresolved merge-conflict markers
The document still contains a ======= separator (line 15) and duplicated “Ideas list” sections further down. This will break rendering and confuses readers. Resolve the conflict before merge.
🧰 Tools
🪛 LanguageTool
[misspelling] ~10-~10: Did you mean “ensuring their”?
Context: ... designing digital badges for AsyncAPI, ensuring they’re visually appealing and fit within our b...
(VBG_THEYRE)
🪛 markdownlint-cli2 (0.17.2)
15-15: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
15-15: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
15-15: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
In
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
around lines 5 to 15, there are unresolved merge conflict markers including a
`=======` separator and duplicated sections. Remove the conflict markers and
consolidate the duplicated "Ideas list" sections to ensure the document renders
correctly and is clear to readers before merging.
| ###### Introduction | ||
|
|
||
| Google Summer of Code (GSoC) is an annual program sponsored by Google that offers stipends to contributors for working on open-source projects during the summer. Contributors gain real-world software development experience by working with mentors from participating organizations. The goal is to encourage developers to contribute to open-source projects and improve their coding skills. If you want to develop open-source software, this program is for you! |
There was a problem hiding this comment.
Demote the “Introduction” heading to H2 for correct hierarchy
###### Introduction jumps six levels down from the document title, breaking MD001 and hurting navigation. Use ## Introduction (or ### if you want a sub-section under an H2 parent).
🧰 Tools
🪛 LanguageTool
[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)
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/summerofcode/README.md around
lines 3 to 5, the heading "Introduction" is currently marked as an H6 (######),
which breaks the heading hierarchy and navigation. Change the heading level to
H2 by replacing ###### with ## to maintain proper document structure and comply
with markdown best practices.
| All communications between AsyncAPI and the Participants, including Github, Slack, and email, will be in English. | ||
|
|
||
| #### Conduct | ||
| Participants must behave professionally and courteously when interacting with other Participants and Program Administrators. If a Participant does not behave professionally and courteously, AsyncAPI may remove the Participant from the Program. | ||
|
|
There was a problem hiding this comment.
Heading levels skip from H3 to H4
#### Changes to the Program (line 43) is an H4 directly under an H2. Promote to H3, or demote parent accordingly, to comply with MD001. Same issue repeats at lines 64, 78, 112.
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
around lines 43 to 112, the heading levels skip from H3 to H4, violating
markdown best practices. Adjust the headings so that `#### Changes to the
Program` and similar headings at lines 64, 78, and 112 are promoted to H3 (###)
or the parent headings are demoted accordingly to maintain a proper hierarchical
structure without skipping levels.
| | Tier | Amount | Benefits | ||
| | --- | --- | --- | |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Markdown table header missing trailing pipe.
Add | at the end of the header row to match column count, e.g.:
-| Tier | Amount | Benefits
+| Tier | Amount | Benefits |Fixes MD056 rendering issues.
📝 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.
| | Tier | Amount | Benefits | |
| | --- | --- | --- | | |
| | Tier | Amount | Benefits | | |
| | --- | --- | --- | |
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md at
lines 23 to 24, the markdown table header row is missing a trailing pipe
character. Add a `|` at the end of the header row line to ensure the column
count matches the separator row, which will fix MD056 rendering issues.
| 1. Automation starts after clicking **Run workflow**. (Unless there is another GitHub Actions outage and proper events are not delivered to automation :smiley: ) | ||
| 1. It creates a new meeting in Zoom. It is, by default, configured to support live streaming | ||
| 1. It creates a GitHub issue with all details about the meeting |
There was a problem hiding this comment.
Singular noun after “another”
“another GitHub Actions outage and proper events” → “another GitHub Actions outage and proper event”.
🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: After the singular determiner ‘another’, use a singular noun. Did you mean “event”?
Context: ...nother GitHub Actions outage and proper events are not delivered to automation :smiley...
(ANOTHER_NNS)
[misspelling] ~28-~28: This expression is normally spelled as one or with a hyphen.
Context: ...t is, by default, configured to support live streaming 1. It creates a GitHub issue with all d...
(EN_COMPOUNDS_LIVE_STREAMING)
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 27 to 29, change the plural noun "events" to the singular "event"
after "another" to correct the grammar. Replace "proper events" with "proper
event" in the sentence about GitHub Actions outage.
| 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: | ||
|
|
||
| 1. In [YouTube](https://youtube.com), click on your profile picture and select `Switch account`: |
There was a problem hiding this comment.
Sentence left unfinished
The paragraph starting “You must start with YouTube first, even though …” trails off with “It is because by”.
Please complete or remove the clause to avoid confusing readers.
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 78 to 82, the sentence starting with "You must start with YouTube
first, even though Restream can directly stream there. It is because by" is
incomplete and confusing. Either complete the sentence with a clear explanation
or remove the unfinished clause entirely to improve readability and avoid
confusion for readers.
| <img src="../../assets/meetings/restream1.png" width="50%"> | ||
|
|
||
| 1. Click `Update Titles` card: | ||
|
|
||
| <img src="../../assets/meetings/restream2.png" width="50%"> | ||
|
|
||
| 1. Provide title and description: | ||
|
|
||
| - Title for the live stream that corresponds with the meeting you just started, | ||
| - Meeting description must be provided even if the field is empty; otherwise, the old one from other streams will be used. | ||
|
|
||
| <img src="../../assets/meetings/restream3.png" width="50%"> | ||
|
|
||
| 1. In Zoom, click the `Live Transcript` button to start transcribing the meeting: | ||
|
|
||
|  | ||
|
|
||
| 1. Confirm transcriptions with `Enable` button: | ||
|
|
||
|  | ||
|
|
||
| 1. Click `More`: | ||
|
|
||
|  | ||
|
|
||
| 1. Select `Live on Custom Live Stream Service` option to start streaming to Restream and, therefore, to official AsyncAPI social networks: | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add alt-text to all embedded images
MD045 triggers for every ![]() without alt text.
Accessible documentation should provide descriptive alt text, e.g.:
-
+Also applies to: 84-125
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
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)
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
between lines 47 and 75, all embedded images lack alt-text, triggering MD045
accessibility warnings. Add descriptive alt-text inside the square brackets for
each image tag to improve accessibility. Repeat this fix for lines 84 to 125 as
well.
| | [derberg](https://github.com/derberg) | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | 2025-04-29 | true | 2025-04-29 | 9 | 0 | 0 | 0 | | ||
| | [magicmatatjahu](https://github.com/magicmatatjahu) | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Abstain">👀</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | 2025-04-29 | true | 2025-04-29 | 6 | 0 | 1 | 2 | | ||
| | [AceTheCreator](https://github.com/AceTheCreator) | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="In favor">👍</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | 2025-03-11 | false | 2025-04-29 | 4 | 0 | 0 | 5 | | ||
| | [NektariosFifes](https://github.com/NektariosFifes) | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | <span style="position: relative; cursor: pointer;" title="Not participated">🔕</span> | Member has not participated in all previous voting process. | false | 2025-04-29 | 0 | 0 | 0 | 9 | |
There was a problem hiding this comment.
Column mis-alignment for NektariosFifes breaks table semantics
The cell under lastParticipatedVoteTime contains a full sentence (“Member has not participated …”) instead of the expected date string.
As a result every subsequent pipe belongs to the wrong header, shifting data rightwards and corrupting the table structure for this row (and anything rendered after it in some Markdown engines).
Please update the generating script to keep the same data type in every column (e.g., leave the date blank or use N/A) and add explanatory text in a footnote rather than inside the cell.
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md at
line 21, the table row for NektariosFifes has a misaligned column where the
lastParticipatedVoteTime cell contains a full sentence instead of a date string,
causing the table structure to break. Fix this by updating the generating script
to ensure that this cell contains only a date string or a placeholder like "N/A"
when no date is available, and move any explanatory text to a footnote outside
the table to maintain proper column alignment.
akshatnema
deleted the
update-community-docs-f4d75491d4d238a53790fd0609edfa7b5ee75f8a
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation
Style
Chores