docs(community): update latest community documentation #4222
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 a major expansion of AsyncAPI's community documentation. It adds comprehensive new guides, governance documents, onboarding resources, mentorship program details, marketing strategies, and configuration updates to surface this content. Several placeholder files signal ongoing documentation efforts. Minor corrections and formatting improvements are also included. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant AsyncAPI Docs
participant GitHub Repo
participant Maintainers
Contributor->>AsyncAPI Docs: Access onboarding, guides, governance, mentorship docs
Contributor->>GitHub Repo: Follows contribution/onboarding steps
GitHub Repo->>Maintainers: Receives PRs, issues, or applications
Maintainers->>GitHub Repo: Review, merge, and manage contributions
Maintainers->>AsyncAPI Docs: Update documentation as needed
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 #4222 +/- ##
=========================================
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: 19
🔭 Outside diff range comments (1)
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
28-34: Broken & inconsistent links in steps 1, 6 and 7Step 6 now links to GitHub with an absolute URL – good.
However:• Step 1 (
/asyncapi/community/blob/master/git-workflow.md) and Step 7 (/asyncapi/community/blob/master/git-workflow.md) are still relative paths that render as broken links on the website.
• Mixing absolute and relative formats is confusing.Please update all three references to use the same, working pattern (either full GitHub URLs or site-local paths that resolve correctly).
🧹 Nitpick comments (90)
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
47-47: Re-add a trailing newline to follow POSIX/text-file conventions
Removing the final newline means the file no longer ends with\n, which can cause subtle diffs and tooling warnings. Consider restoring a single newline character at EOF for consistency across the repo.markdown/docs/community/011-styleguide/numbers.md (1)
155-161: Inconsistent timezone formatting within the same sectionLine 61 uses “3 PM UTC” (no parentheses) while lines 158–159 use “11:00 AM (UTC)” and “3:15 PM (UTC)”. Pick one convention (with or without parentheses) and apply it consistently across all time examples in the style-guide to avoid confusing readers.
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
97-101: Consider hyphenating the compound adjectiveIn “Open Source Best Practices”, “open-source” functions as a compound adjective modifying “best practices”. Hyphenating it aligns with common style-guide recommendations.
markdown/docs/community/040-guides/keep-repository-settings-consistent.md (2)
11-19: Minor wording & accessibility tweaks
- “Make sure the Sponsorships option is selected …” – missing article.
- Replace “cover mostly all the needs” with “cover most needs”.
- The embedded screenshot lacks alt-text – add descriptive text for accessibility.
24-34: Bare URLs and dash rules flagged by linters
MD034/MD034: wrap naked SonarCloud URLs in angle brackets or convert them to markdown links.
MD034: same for the create-project link.
This keeps the file lint-clean and consistent with the rest of the docs.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)
21-26: Lint: bare URL inside tableRow #6 in the table contains a raw link. Convert it to
[discussion]()or wrap it in< >to satisfyMD034.markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (2)
18-25: Tabs & punctuation
- Replace hard tabs with spaces (
MD010).- “had 2 projects, and we hired 6 Technical Writers” – comma needed before the conjunction.
- Change “June - August” / “September - October” to an en-dash “June – August” (
–) for range style (LanguageTool DASH_RULE).
40-41: Bare URL at line 41Wrap the project-proposal URL in angle brackets or a markdown link to silence
MD034.markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (2)
5-22: Use en-dashes and verify date/ordinal consistency in the timeline bullets.Examples:
- “February 22 - March 18” → “February 22 – March 18”
- “May 1 - 26” → “May 1 – 26”
- Double-check that every day number uses the correct ordinal suffix (e.g., “3rd”, “22nd”).
Consistent typography avoids repeated markdown-lint (MD034/DASH_RULE) warnings and reads more professionally.
24-33: Fix spelling & casing within the accepted-projects table.Line 33 currently spells “Maintainance”; correct spelling is “Maintenance”.
While you’re editing, ensure product names follow official casing (e.g., “VS Code”, “Open Graph”), and that all issue links remain valid.markdown/docs/community/050-mentorship-program/README.md (1)
18-26: Table rows miss trailing pipes → breaks some renderers.Rows 24-25 (“OpenForce”, “Hacktoberfest”) have no closing
|, triggering MD055. Add the trailing pipe to keep the table layout consistent across GitHub / Docusaurus / Markdown-it.markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (3)
2-2: Typos: “annoucement” → “announcement”.Minor but worth fixing—the heading is one of the first things readers see.
11-18: Ordinal suffix & spelling issues in timeline.• “23th January” → “23rd January”
• “Promos about WOC…”: consider “promotions” for clarity.These small fixes remove LanguageTool warnings (ORDINAL_NUMBER_SUFFIX).
25-33: Table style violates MD055 and contains typos.– Add trailing
|pipes for every row.
– “date-time formate” → “date-time format” (row 4).
– Capitalise product names: “URL”, “Netlify”, “Zapier”.Uniform tables render reliably across all site engines.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (2)
5-7: Timeline phrasing & plural consistency.• “Mentees applications” → “Mentee applications”
• Space missing: “18weeks” → “18 weeks”
• Replace “+” with “and” or an en-dash for accessibility.
12-22: Table needs blank lines above/below (MD058) and several casing fixes.Insert a blank line before the header row to silence markdown-lint.
Within rows:
– “typescript” → “TypeScript”
– Ensure GitHub handles correspond to the names (row 7 lists the same handle twice).markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (3)
1-4: Heading wording & level.Change “Projects ideas” → “Project ideas”.
Heading level jumps from H1 → H3 at line 4; use H2 to keep hierarchy incremental (MD001).
9-10: Grammar: “the one of the most used” → “one of the most used”.Also consider adding a comma after the introductory clause for readability.
15-16: “allow to build” construction is awkward.Recommend “allow building” or “enable users to build” to avoid LanguageTool’s ALLOW_TO warning.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md (1)
18-18: Use the correct framework spelling (“Node.js”).The official spelling of the framework is “Node.js”, not “NodeJS”. Using the correct name avoids style violations flagged by spell-checkers and keeps terminology consistent across the docs.
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (3)
7-7: Fix heading-level jump (MD001).
### Contact informationshould be## Contact informationto avoid skipping from H1 to H3.
32-32: Insert missing comma for readability.Add a comma after “abilities” in
“code unrelated to AsyncAPI demonstrating your development abilities(Optional).”
39-39: Replace “independently from” with “independently of”.The standard collocation is “independently of the official project”.
markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (2)
1-1: Add missing article.“The AsyncAPI Community uses Slack …” reads better than starting without an article.
10-10: Insert comma before “read”.Add a comma in “For more details, read this article …” to improve flow.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
43-43: Comma after “for example”.Grammar convention calls for a comma after “For example,” in the sentence introducing the sample PR.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (4)
1-1: Singularize heading.“Project ideas” is correct; drop the plural “Projects”.
4-8: Surround table with blank lines (MD058).Insert a blank line before and after the table to satisfy markdown-lint and improve readability.
11-11: Remove comma before “because”.The clause is essential; “Community uses diff protocols because …” flows without the comma.
12-12: Use “Node.js” instead of “NodeJS”.Maintain consistency with the official framework spelling.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (3)
13-15: Heading level breaks hierarchy
# Blog post requirementsjumps from an H2 (## Contribute AsyncAPI blog posts) back to an H1.
Use###(or##if you want a peer section) to keep incremental heading levels and satisfy MD001.
18-23: Bare URL & accessibility detailsLine 22 contains a raw URL. Wrap it in angle brackets or markdown link syntax to silence MD034.
While touching this section, double-check that every image example also shows correctalttext formatting to reinforce the accessibility guidance you outline.
5-6: Minor clarity tweak“ask on the community Slack to help promote it whenever it is released” reads awkwardly.
Consider “ask in the community Slack for help promoting it upon release.”
Purely editorial – feel free to ignore if tone is intentional.markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
47-49: Bare email URL triggers MD034Convert
conduct@asyncapi.ioand the committee link to proper markdown links or wrap the address in angle brackets to keep markdown-lint happy.markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
68-70: Small grammar / readability nit“Join our Slack workspace … Observe our Slack etiquette …” – missing conjunction causes a run-on sentence.
Consider splitting into two sentences or inserting “and”.markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (2)
3-6: Heading level jumpUsing
##### Introductionimmediately after an H1 triggers MD001.
Drop to##or###to keep consistent levels.
11-15: Repetitive “You’ll need to …” phrasingMultiple sentences start with the same phrase, making the guideline feel monotonous. Vary sentence openings for better flow (e.g., “Provide guidance…”, “Encourage collaboration…”, “Set clear expectations…”).
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (2)
5-6: Fix sentence structure in Purpose section“responds to investigates, and resolves” is missing a comma (or “to”). It should read “responds to, investigates, and resolves” for correct parallelism.
26-29: Consider splitting the decision-making paragraphThe single, 400-word sentence covering consensus, majority vote, quorum, written agreement, and emergencies is difficult to parse. Breaking it into shorter sentences or bullet points would improve readability and reduce cognitive load for incident respondents.
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (3)
27-38: Table formatting violates MD055The table lacks trailing pipes on each row, causing markdownlint failures and inconsistent rendering in some viewers. Add a pipe (
|) at the end of each header and data row.
42-45: Unordered-list style inconsistent with repository settings
*is used here, whereas the rest of the document (and markdownlint rule MD004) expect-. Align list markers for uniform style.
8-13: Minor wording & link etiquette• “slack” → “Slack” for proper noun.
• Sentence starting “You come up with the idea that we used…” is awkward; consider re-phrasing for clarity.
• Convert bare Slack invite URL to an inline Markdown link to avoid MD034 lint warnings.markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (3)
6-14: Use en-dashes for date rangesMarkdownlint flags the hyphen usage (
-) in “January 23 - Organization…” etc. Replace with an en-dash (–) or “to” for stylistic correctness.
45-49: Typos and casing• “requried” → “required”.
• “nodejs” → “Node.js”.
Fixing these improves professionalism of the mentorship brief.
50-60: Clarify bot descriptionThe phrase “checkes if voters file was edited” contains a typo and could be clearer. Suggest “checks whether the VOTERS file was modified” for precision.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
70-87: Inconsistent URL protocols in remote examples
git remote add upstream https://…is followed by example output showinggit@github.com:…. Using mixed HTTPS and SSH in the same example may confuse newcomers. Pick one protocol for both snippets.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (3)
13-14: Typo in bullet title: “Specifing” → “Specifying”Minor spelling slip. Correcting it keeps the doc looking professional.
44-50: Use an en dash for date rangesMarkdown style across the repo typically uses “June – August”, “September – October”, etc. Switching the hyphen to an en dash improves typographic consistency.
54-61: Currency wording is redundantThe phrase “$350 dollars” repeats the currency symbol. Recommend either “USD 350” or simply “$350”.
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (2)
44-46: Spell “Node.js” consistentlyLines 62, 71 and 80 list “Node js”. The canonical spelling is “Node.js”. Aligning with official branding avoids confusion.
8-19: JavaScript capitalisationLines 8 and 17 have “Javascript/Typescript”. Use “JavaScript/TypeScript” to follow standard capitalisation.
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (1)
70-79: Excessive exclamation marksThe closing sentence contains multiple exclamation marks; one is plenty for a friendly tone without feeling informal.
markdown/docs/community/COC-incident-resolution-procedures.md (1)
21-22: Hard tabs presentA couple of list items use tab characters (MD010). Convert them to spaces for consistent formatting.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (2)
30-31: Missing possessive apostrophe“Participants final source code” should read “Participant’s final source code”. Adds clarity and grammatical correctness.
129-133: “Amount of stipends” → “number of stipends”“Stipends” is countable. Using “number” reads more naturally.
markdown/docs/community/050-mentorship-program/summerofcode/README.md (3)
3-5: Heading level is unexpectedly deep
###### Introductionrenders as an H6, which is visually tiny and skips five heading levels from H1. Use an H2/H3 (##or###) to keep the hierarchy readable and consistent with the rest of the doc set.
10-14: Section name should be plural
### Requirementimplies a single item, yet multiple eligibility rules follow. Rename the header to### Requirementsfor clarity.
36-38: Missing URL scheme breaks link on some markdown renderers
[AsyncAPI website](asyncapi.com)lackshttps://. Add the scheme to avoid dead links in contexts that don’t auto-prefix.markdown/docs/community/020-governance-and-policies/voting.md (1)
20-26: Hard-coded quorum math example can drift“If TSC has 40 members … 51% multiplied by 40 … at least 21”
If membership changes, the example quickly becomes wrong. Replace with a formula description (e.g., “
ceil(0.51 * current_member_count)”) or drop the numeric example.markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (3)
26-28: Singular–plural mismatch“the type of contributions:” → should be “the types of contributions” to agree with the plural noun “contributions”.
39-44: Section title grammar
### Ambassadors dutiesmixes plural noun with plural possessive. Prefer### Ambassador dutiesor### Ambassadors’ dutiesfor correctness.
55-62: Overly detailed “how to fetch IDs” blockquote clutters main flowThe four-step GitHub/Slack ID walkthrough is useful but long. Consider moving it to an appendix or separate “How to find your IDs” doc and link to it, keeping this file concise.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (2)
102-104: Duplicate donation button blockThe anchor/button snippet already appears at lines 30-33. Duplicating it here can confuse readers and hurt page load. Drop one instance.
107-108: Informal wording in contact sentence“Feel free to contact us if you need more explanation. We are happy to hop on a call…” — Trim “Feel free” and use “additional information” for a more professional tone.
markdown/docs/community/020-governance-and-policies/CHARTER.md (1)
56-57: Semicolon followed by conjunction“code base that affect multiple projects; and 10.” — The conjunction after a semicolon is grammatically awkward. Replace
; andwith a comma or start a new sentence.markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1)
16-17: Add missing definite articles for clarity“… files in same repository” → “… files in the same repository”
“… provide correctrepoUrl” → “… provide the correctrepoUrl”.Small but recurring omissions make the prose feel unfinished and may confuse non-native readers.
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (1)
12-12: Correct spelling
Specifing→Specifying.
Typos in headings hurt searchability.markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
31-33: Typo in sentence“…channels that no one publishes too” should be “…channels that no one publishes to”.
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (3)
12-16: Remove duplicated introductory paragraphLines 12-16 repeat nearly the same text twice, bloating the file and harming readability.
Delete one occurrence or merge unique bits into a single paragraph.
53-53: Grammar: incorrect phrase“This could be inform of the Bounty Program.” → “This could be in the form of the Bounty Program.”
84-84: Spelling
quater→quarter.markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (2)
23-24: Subject-verb agreement
contributors/maintainers reviews→contributors/maintainers review.
65-65: Spelling
preperation→preparation.markdown/docs/community/onboarding-guide/github-actions.md (2)
58-61: Unify bullet-point style
markdownlintflags the mixed use of*and-for unordered lists (MD004). Earlier lists in this file use dashes; these three items use asterisks. Pick one style (AsyncAPI docs usually prefer-) and stick to it throughout the file to avoid needless style-lint noise.
95-103: Promote “Opt-in / Opt-out” to real headingsLines 95-103 use bold text to simulate section titles, triggering MD036 (“emphasis used instead of a heading”). Replace them with
#### Opt-inand#### Opt-out(or another appropriate level) so they appear in the ToC and keep structure consistent.markdown/docs/community/020-governance-and-policies/donating-projects.md (2)
5-6: Add missing article and capitalize initiative name“The AsyncAPI Initiative is open to receiving project donations …” reads more naturally and matches branding.
Current wording drops the definite article and uses lowercase, which feels off in formal docs.
38-40: Drop comma before “because”“… ask for a vote on migrating your project to the organization, because the Technical Steering Committee…”
The clause after “because” is essential; no comma is needed. Removing it will silence common grammar linters.
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (2)
71-76: Consistent list markersThis list uses
-while surrounding lists use*, again tripping MD004. Standardise on one marker to keep markdown-lint green.
82-84: Convert bare URL to markdown link
https://www.asyncapi.com/community/tscis rendered as a raw URL (MD034). Wrap it:[AsyncAPI TSC page](https://www.asyncapi.com/community/tsc).markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (2)
7-8: Tighten phrasing“In a transparent manner” → “transparently” is shorter and clearer.
22-23: Avoid bare URLsLine 22 contains a naked link. Convert to
[MEETINGS_ORGANIZATION.md](https://github.com/asyncapi/community/blob/master/MEETINGS_ORGANIZATION.md)(silences MD034).markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (1)
12-15: Hyphenate compound adjective“open-source maintainers” (with a hyphen) is the standard form when the phrase modifies a noun. This tiny change fixes LanguageTool’s EN_COMPOUND_ADJECTIVE_INTERNAL warning and improves readability.
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (6)
16-18: Unify bullet-list marker style
MD004flags the use of*here while the rest of the doc uses-. Mixing styles hurts readability and fails markdown-lint checks.
Please standardise on a single unordered-list marker (the repo typically prefers-).
27-29: Minor grammar: singular after “another”“…another GitHub Actions outage and proper events …”
After “another”, a singular noun is expected (“event”).
Updating this removes theLanguageToolwarning and reads more naturally.
74-76: Image reference uses empty alt text in markdown
renders without description. Supply an alt label for accessibility and to silenceMD045.
161-162: Spelling: “Committee”
Technical Steering Commitee→Technical Steering Committee.
Correcting avoids confusion and maintains professional tone.
168-168: Replace vague verb “give”“…so he can give you access…”
Style checker suggests stronger wording such as “grant you access”.
Not critical, but improves clarity.
172-238: Consider splitting very long sectionThe “publish broadcasted meetings as podcasts” block spans >60 lines and multiple sub-topics (why, who, prerequisites, examples, steps). Breaking it into smaller H3/H4 sections or a separate doc would aid skimming and future maintenance.
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (2)
28-30: Heading wording: “Corporation” → “Corporate” involvement“Corporate involvement” is the conventional phrasing when referring to companies’ engagement.
31-33: Run-on sentence; missing space after period
“…repository](https://github.com/asyncapi/training), which we can record and build upon.Once we…”Insert a space (or newline) after the period to avoid lint/style warnings.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (58)
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)
🧰 Additional context used
🧠 Learnings (18)
📓 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: 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: 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: 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 (5)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: 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: bandantonio
PR: asyncapi/website#3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#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 (3)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
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/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/summerofcode/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/asyncapi-mentorship/2023/project-ideas.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/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/contribute-blog-post.md (3)
Learnt from: iambami
PR: asyncapi/website#4111
File: markdown/blog/community-spotlight-aayush.md:3-3
Timestamp: 2025-06-03T06:48:09.304Z
Learning: For AsyncAPI community spotlight blog posts, the frontmatter date should reflect the actual publication date, not the month being highlighted in the spotlight. For example, a "May Community Spotlight" can be published in June with a June date in the frontmatter.
Learnt from: Siddhant-Pragyan-Sinha
PR: asyncapi/website#4074
File: markdown/blog/open-nest.md:11-12
Timestamp: 2025-04-28T01:13:59.084Z
Learning: For AsyncAPI blog posts, author photo filenames don't necessarily need to match the author's official name, as some authors may use pen names or nicknames (e.g., Aishat Muibudeen using "maya_picture.webp" for her avatar).
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/onboarding-guide/github-actions.md (5)
Learnt from: akshatnema
PR: asyncapi/website#3168
File: jest.config.js:6-6
Timestamp: 2024-10-15T17:44:59.227Z
Learning: In this repository, the `coverage` directory is added to `.gitignore`, and coverage reports are generated during GitHub Actions runs.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: .github/workflows/check-edit-links.yml:25-29
Timestamp: 2025-01-08T15:16:27.655Z
Learning: In GitHub workflows running scripts with process.exit statements for error handling (like check-editlinks.js in asyncapi/website), avoid adding error suppression (|| true) at the workflow level as it would mask the intended error reporting mechanism.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: .github/workflows/check-edit-links.yml:30-37
Timestamp: 2025-01-14T14:57:08.491Z
Learning: In GitHub Actions workflows, avoid using {...} blocks for output redirection. Instead, use individual redirects with proper quoting as recommended by GitHub Docs. For example:
```yaml
echo "key<<EOF" >> "${GITHUB_OUTPUT}"
echo "${value}" >> "${GITHUB_OUTPUT}"
echo "EOF" >> "${GITHUB_OUTPUT}"
```
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.
Learnt from: akshatnema
PR: asyncapi/website#3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.
Learnt from: akshatnema
PR: asyncapi/website#3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the `tests/fixtures/tools/automated-tools.json` file, the `language` field within the `filters` object can be either a string or an array. Both formats are acceptable and supported in the codebase.
markdown/docs/community/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/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/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/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
Learnt from: aminoxix
PR: asyncapi/website#4127
File: components/layout/CommunityLayout.tsx:179-179
Timestamp: 2025-06-10T06:27:25.419Z
Learning: In AsyncAPI's community data structure, ambassadors and TSC members are guaranteed to have GitHub accounts. The `github` field is required in both `Ambassador` and `Tsc` interfaces, and the data processing in `addAdditionalUserInfo()` converts GitHub usernames to full URLs, ensuring safe string operations when extracting usernames from URLs.
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (2)
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
🪛 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/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/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)
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/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/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/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/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/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/010-contribution-guidelines/recognize-contributors.md
[style] ~11-~11: Consider replacing this word to strengthen your wording.
Context: ...ull requests. You are a language expert and can review docs or an expert in a speci...
(AND_THAT)
[style] ~15-~15: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: ...ues or in Slack You can help us out in many different ways. Just check out [this](https://allcontr...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~17-~17: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... if we failed in recognizing your work. Feel free to contact us on [slack](https://asyncapi....
(FEEL_FREE_TO_STYLE_ME)
[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/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/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/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/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/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/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/seasonofdocs/2023/README.md
[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/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/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/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/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/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/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/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/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/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/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/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/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/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/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: Possible missing article found.
Context: ...e you can write a script to synchronize master branch of your fork with the master bra...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~50-~50: Possible missing article found.
Context: ... of your fork with the master branch of upstream git repository. Check [this script](htt...
(AI_HYDRA_LEO_MISSING_THE)
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] ~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/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/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/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)
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/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/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: Possible missing article found.
Context: ...s changed. So if there was an update in payload, the library must specify what channel ...
(AI_HYDRA_LEO_MISSING_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] ~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: Possible missing comma found.
Context: ...what is missing to make it possible. As prerequisite you of course need to read about curren...
(AI_HYDRA_LEO_MISSING_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/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/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)
[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)
[style] ~67-~67: ‘a majority of the’ might be wordy. Consider a shorter alternative.
Context: ...can only be removed upon resignation or a majority of the TSC votes. Next steps will be specified...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF_THE)
[style] ~93-~93: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...rovided in Section 6, decisions require a majority of votes. 4. Decisions must always be made...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cribe the contribution, the alternative open source license(s), and the justification for u...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... justification for using an alternative open source license for the Project. License except...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~119-~119: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...ject to approval by the Series Manager. In the event that a Project-specific CoC has not been app...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
[style] ~120-~120: 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/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)
[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/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/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)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/040-guides/keep-repository-settings-consistent.md
24-24: Bare URL used
(MD034, no-bare-urls)
25-25: 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)
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)
17-17: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md
2-2: Bare URL used
(MD034, no-bare-urls)
16-16: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
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/onboarding-guide/upholding-code-of-conduct.md
47-47: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md
21-21: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
28-28: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
43-43: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
44-44: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
22-22: Hard tabs
Column: 21
(MD010, no-hard-tabs)
24-24: Hard tabs
Column: 29
(MD010, no-hard-tabs)
41-41: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/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/2023/project-ideas.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md
59-59: Bare URL used
(MD034, no-bare-urls)
62-62: Blank line inside blockquote
(MD028, no-blanks-blockquote)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md
22-22: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/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/020-governance-and-policies/WORKING_GROUPS.md
22-22: Bare URL used
(MD034, no-bare-urls)
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/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/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
17-17: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
22-22: Bare URL used
(MD034, no-bare-urls)
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/040-guides/add-new-asyncapi-tool-to-website.md
63-63: Hard tabs
Column: 15
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 38
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 51
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 19
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 26
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 12
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 122
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 18
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 186
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 194
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 12
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 84
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 91
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 23
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 97
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 104
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 19
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 99
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 105
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 19
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 278
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 285
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 14
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 147
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 155
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 23
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 469
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 475
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 25
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 481
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 489
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 25
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 427
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 435
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 28
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 109
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 137
(MD010, no-hard-tabs)
markdown/docs/community/030-project-vision-strategy-goals/2025_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/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/2021/README.md
18-18: Bare URL used
(MD034, no-bare-urls)
25-25: Bare URL used
(MD034, no-bare-urls)
43-43: Spaces inside link text
(MD039, no-space-in-links)
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/020-governance-and-policies/TSC_MEMBERSHIP.md
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
83-83: 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)
⏰ Context from checks skipped due to timeout of 180000ms (4)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (11)
markdown/docs/community/011-styleguide/grammar.md (1)
75-76: LGTM – stray bullet fixedThe extra dash was removed, restoring a clean bullet list.
markdown/docs/community/050-mentorship-program/README.md (2)
12-15: Link target appears wrong.The Discussions URL points at
cncf/mentoring. Unless that repo intentionally hosts AsyncAPI threads, replace with the AsyncAPI organisation’s Discussions board to avoid sending users to an unrelated CNCF space.
29-41: Statistics table is structurally inconsistent.Several rows omit the last cell, so the “Total (per year)” column shifts and the 2023 subtotal reads as “18”. Either:
• Fill the blanks with
| |where totals aren’t needed
• Or compute totals for every yearThis prevents mis-aligned HTML when the site converts the table.
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (1)
1-3: No issues – auto-generated file looks goodContent is auto-generated; header warning is present. Nothing actionable.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
96-107: Branch-tracking explanation could mislead
git branch -u upstream/master mastersets localmasterto track remoteupstream/master, not the fork’s origin. Explicitly note that pushes will still default tooriginunlesspush.defaultis changed, to prevent accidental pushes to the upstream repo.markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (1)
76-77: Broken link targetThe “git workflow guide” link points to
community/blob/master/git-workflow.md, but the new guide seems to live under010-contribution-guidelines/git-workflow.md. Please verify the path.markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1)
70-70: Fix verb agreement
doesn't matches→doesn't match⛔ Skipped due to learnings
Learnt from: akshatnema PR: asyncapi/website#3136 File: scripts/tools/combine-tools.js:122-125 Timestamp: 2024-11-01T12:49:32.805Z Learning: In `scripts/tools/combine-tools.js`, the existing URL parsing logic for `repoUrl` without additional error handling is acceptable and does not require changes.Learnt from: akshatnema PR: asyncapi/website#3265 File: tests/helper/toolsObjectData.js:1-18 Timestamp: 2024-12-02T05:52:49.547Z Learning: In `tests/helper/toolsObjectData.js`, using the hard-coded repository ID directly in the URL is acceptable when creating mock data for tests, as we are not asserting anything at `REPO_ID`.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/seasonofdocs/2023/project-ideas.md (1)
19-21: Plural noun missing“specify thing that are common” → “specify things that are common”.
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (1)
97-98: Consistent product naming
Mastadon→Mastodon(official spelling) in both occurrences.Also applies to: 115-115
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (2)
37-56: Mermaid block fencingThe opening fence uses
mermaid (three back-ticks + space + keyword). Some Markdown engines (including the one powering asyncapi.com) expectmermaid (no space).
Confirm it renders as intended; otherwise drop the space.
65-72: Broken link referenceThe “Working Groups” link points to
.../WORKING_GROUPS.mdincommunityroot, but the new governance docs place it undermarkdown/docs/community/020-governance-and-policies/.
Double-check that the rendered site doesn’t produce a 404.
| 🚧 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.
Missing front-matter will break the docs build
All community docs use YAML front-matter (---, title, description, weight, …).
Without it, the static-site build will render this file incorrectly or fail during the build step.
Add minimal front-matter, even for placeholders, e.g.:
+---
+title: Community Glossary
+description: Definitions of common AsyncAPI community terms.
+weight: 10
+draft: true
+---
+
🚧 This document is under construction.📝 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: Community Glossary | |
| description: Definitions of common AsyncAPI community terms. | |
| weight: 10 | |
| draft: true | |
| --- | |
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 |
🤖 Prompt for AI Agents
In markdown/docs/community/community-glossary.md at the beginning of the file
(lines 1 to 3), the document is missing the required YAML front-matter which is
necessary for the static-site build to work correctly. Add minimal YAML
front-matter including keys like `title`, `description`, and `weight` enclosed
between triple dashes (`---`) at the top of the file to ensure the build process
does not fail.
| 🚧 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.
Placeholder lacks required front-matter
Same issue as the glossary: the page needs YAML front-matter so the website generator can pick it up and so its draft status can be indicated.
Suggested minimal template:
+---
+title: AsyncAPI Roadmap
+description: High-level roadmap (work-in-progress).
+weight: 20
+draft: true
+---
+
🚧 This document is under construction.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 | |
| --- | |
| title: AsyncAPI Roadmap | |
| description: High-level roadmap (work-in-progress). | |
| weight: 20 | |
| draft: true | |
| --- | |
| 🚧 This document is under construction. | |
| Please be patient as we work on it. Thank you. 🫶 |
🤖 Prompt for AI Agents
In markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md at the
beginning of the file (lines 1 to 3), add the required YAML front-matter block
to enable the website generator to recognize the page and mark it as a draft.
Insert a minimal front-matter template enclosed by triple dashes, including at
least a title and a draft status field, before any other content in the file.
| 🚧 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.
Missing YAML front-matter header
All community docs normally start with a front-matter block (---, title, weight, …).
Without it, the site generator will treat the page as raw Markdown and break navigation / sorting.
Please add a minimal header consistent with neighbouring docs before merging.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md at
the beginning of the file (lines 1 to 3), add a YAML front-matter header block
enclosed by triple dashes (---). Include at least the title and weight fields
consistent with neighboring community docs to ensure proper site generation,
navigation, and sorting. This header should be placed before any other content
in the file.
| 🚧 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.
Front-matter header is required
This placeholder page lacks the mandatory title / weight front-matter.
Add it now to avoid build-time errors and to keep the sidebar order predictable.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/where-to-contribute.md at the
beginning of the file (lines 1 to 3), add the required front-matter header
including at least the `title` and `weight` fields. This front-matter should be
enclosed in triple dashes and placed before any content to prevent build errors
and ensure the sidebar order is maintained.
| 🚧 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.
🛠️ Refactor suggestion
Add metadata before publishing
The onboarding docs section expects every file to carry a YAML front-matter header; omitting it will break link resolution and may cause 404s.
Recommend adding at least:
---
title: How to Contribute
weight: <next-available>
---
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/how-to-contribute.md at the beginning
of the file (lines 1 to 3), add a YAML front-matter header with at least a title
and weight field. This metadata is required for proper link resolution and to
prevent 404 errors. Insert the following at the top: three dashes, then title:
How to Contribute, weight with the next available number, and closing three
dashes.
| --- | ||
| <p align="center"><strong>Technical Charter (the “Charter”)</strong></p> | ||
| <p align="center"> | ||
| for</br> | ||
| AsyncAPI Project a Series of LF Projects, LLC</br> | ||
| Adopted 03-19-2021, Amended 05-05-2025 | ||
| </p> | ||
|
|
There was a problem hiding this comment.
Front-matter fence never closed
A --- opener without a matching closing --- breaks many static-site generators and will cause build failures. Close the YAML front-matter block before the HTML <p> lines, or remove the opening delimiter if no front-matter is intended.
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/CHARTER.md at lines 1 to
8, the YAML front-matter block is opened with `---` but never closed, causing
build failures. To fix this, either add a closing `---` line immediately after
the opening `---` if front-matter content is intended, or remove the opening
`---` entirely if no front-matter is needed, ensuring the HTML `<p>` lines are
outside any YAML block.
| You can also follow a simple example of `.asyncapi-tool` file to render the tool in website. This is example of [AsyncAPI Bundler](https://github.com/asyncapi/bundler). `.asyncapi-tool` file in YAML format: | ||
|
|
||
| ```YAML | ||
| title: AsyncAPI Bundler | ||
| filters: | ||
| languages: | ||
| - TypeScript | ||
| technology: | ||
| - TypeScript | ||
| categories: | ||
| - bundler | ||
| ``` |
There was a problem hiding this comment.
Schema field name typo breaks example
The YAML sample uses languages: (plural) whereas the schema earlier defines language: (singular).
This mismatch will cause automated validation to fail and mislead readers.
- languages:
- - TypeScript
+ language: TypeScriptIf plural support is intentional, update the schema description above instead.
📝 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.
| You can also follow a simple example of `.asyncapi-tool` file to render the tool in website. This is example of [AsyncAPI Bundler](https://github.com/asyncapi/bundler). `.asyncapi-tool` file in YAML format: | |
| ```YAML | |
| title: AsyncAPI Bundler | |
| filters: | |
| languages: | |
| - TypeScript | |
| technology: | |
| - TypeScript | |
| categories: | |
| - bundler | |
| ``` |
🧰 Tools
🪛 LanguageTool
[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)
🤖 Prompt for AI Agents
In markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md around
lines 77 to 88, the YAML example uses the field name "languages" (plural) which
does not match the schema's defined field "language" (singular). To fix this,
change "languages" to "language" in the YAML example so it aligns with the
schema and passes validation. If plural is intended, update the schema
accordingly instead.
| | Field Name | Type | Description | Required | | ||
| |:---:| :---: |--- |:---: | | ||
| | `title` | String | Specifies the title or name of the tool; the official name of your tool on the website. | Yes | | ||
| | `description` | String | Specifies the tool's description. * denotes that this field can be left blank/skipped if you wish to display Github repository description in the Tool Card | No* | | ||
| | `links` | Object | Object which contains important links related to the tool. | No | | ||
| | `links.websiteUrl` | String | This is an optional field specifying the tool's website URL. | No | | ||
| | `links.docsUrl` | String | This is an optional field specifying the tool's documentation URL. | No | | ||
| | `links.repoUrl` | String | This is an optional field specifying the tool's repository URL. By default, the URL matches the repo where .asyncapi-tool file is located. You can override default behaviour in cases when you have multiple .asyncapi-tool files in your repository. | No* | | ||
| | `filters` | Object | Object which contains various fields like language, technologies, and categories to provide information about the tool. | Yes | | ||
| | `filters.language` | String | Specifies the primary language in which you created the tool. Our documentation lists [predefined languages](https://github.com/asyncapi/website/blob/master/scripts/tools/tags-color.ts), and you can expand this list to add new languages according to your need. To add a new language, you have to create a [new issue on GitHub repository](https://github.com/asyncapi/website/issues/new/choose) specifying the language you want to add. | No | | ||
| | `filters.technology` | Array of strings | Specifies the technologies used to create the tool. Our documentation lists [predefined technologies](https://github.com/asyncapi/website/blob/master/scripts/tools/tags-color.ts), and you can expand this list to add new technologies according to your need. To add a new technology, you have to create a [new issue on GitHub repository](https://github.com/asyncapi/website/issues/new/choose) specifying the technology you want to add. | Yes | | ||
| | `filters.categories` | Array of strings | Specifies the list of categories that defines the type of tool. There are [predefined categories](https://github.com/asyncapi/website/blob/master/scripts/tools/categorylist.ts) in our documentation that you can use to list your tool under the proper category. If your tool doesn't matches with any categories specified in list, you can choose `others` option to list your tool. | Yes | | ||
| | `filters.hasCommercial` | Boolean | Specifies whether the tool is a commercial product or open source. | No (`false` by default) | |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace hard tabs in the Markdown table
The table rows are separated by tab characters (\t).
Many Markdown renderers treat tabs inconsistently, causing mis-aligned columns or completely broken tables.
Use spaces or the pipe/space pattern exclusively:
-| Field Name | Type | Description | Required |
+| Field Name | Type | Description | Required |Repeat for all affected lines (63-75).
📝 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.
| | Field Name | Type | Description | Required | | |
| |:---:| :---: |--- |:---: | | |
| | `title` | String | Specifies the title or name of the tool; the official name of your tool on the website. | Yes | | |
| | `description` | String | Specifies the tool's description. * denotes that this field can be left blank/skipped if you wish to display Github repository description in the Tool Card | No* | | |
| | `links` | Object | Object which contains important links related to the tool. | No | | |
| | `links.websiteUrl` | String | This is an optional field specifying the tool's website URL. | No | | |
| | `links.docsUrl` | String | This is an optional field specifying the tool's documentation URL. | No | | |
| | `links.repoUrl` | String | This is an optional field specifying the tool's repository URL. By default, the URL matches the repo where .asyncapi-tool file is located. You can override default behaviour in cases when you have multiple .asyncapi-tool files in your repository. | No* | | |
| | `filters` | Object | Object which contains various fields like language, technologies, and categories to provide information about the tool. | Yes | | |
| | `filters.language` | String | Specifies the primary language in which you created the tool. Our documentation lists [predefined languages](https://github.com/asyncapi/website/blob/master/scripts/tools/tags-color.ts), and you can expand this list to add new languages according to your need. To add a new language, you have to create a [new issue on GitHub repository](https://github.com/asyncapi/website/issues/new/choose) specifying the language you want to add. | No | | |
| | `filters.technology` | Array of strings | Specifies the technologies used to create the tool. Our documentation lists [predefined technologies](https://github.com/asyncapi/website/blob/master/scripts/tools/tags-color.ts), and you can expand this list to add new technologies according to your need. To add a new technology, you have to create a [new issue on GitHub repository](https://github.com/asyncapi/website/issues/new/choose) specifying the technology you want to add. | Yes | | |
| | `filters.categories` | Array of strings | Specifies the list of categories that defines the type of tool. There are [predefined categories](https://github.com/asyncapi/website/blob/master/scripts/tools/categorylist.ts) in our documentation that you can use to list your tool under the proper category. If your tool doesn't matches with any categories specified in list, you can choose `others` option to list your tool. | Yes | | |
| | `filters.hasCommercial` | Boolean | Specifies whether the tool is a commercial product or open source. | No (`false` by default) | | |
| | Field Name | Type | Description | Required | | |
| |:---:| :---: |--- |:---: | | |
| | `title` | String | Specifies the title or name of the tool; the official name of your tool on the website. | Yes | | |
| | `description` | String | Specifies the tool's description. * denotes that this field can be left blank/skipped if you wish to display Github repository description in the Tool Card | No* | | |
| | `links` | Object | Object which contains important links related to the tool. | No | | |
| | `links.websiteUrl` | String | This is an optional field specifying the tool's website URL. | No | | |
| | `links.docsUrl` | String | This is an optional field specifying the tool's documentation URL. | No | | |
| | `links.repoUrl` | String | This is an optional field specifying the tool's repository URL. By default, the URL matches the repo where .asyncapi-tool file is located. You can override default behaviour in cases when you have multiple .asyncapi-tool files in your repository. | No* | | |
| | `filters` | Object | Object which contains various fields like language, technologies, and categories to provide information about the tool. | Yes | | |
| | `filters.language` | String | Specifies the primary language in which you created the tool. Our documentation lists [predefined languages](https://github.com/asyncapi/website/blob/master/scripts/tools/tags-color.ts), and you can expand this list to add new languages according to your need. To add a new language, you have to create a [new issue on GitHub repository](https://github.com/asyncapi/website/issues/new/choose) specifying the language you want to add. | No | | |
| | `filters.technology` | Array of strings | Specifies the technologies used to create the tool. Our documentation lists [predefined technologies](https://github.com/asyncapi/website/blob/master/scripts/tools/tags-color.ts), and you can expand this list to add new technologies according to your need. To add a new technology, you have to create a [new issue on GitHub repository](https://github.com/asyncapi/website/issues/new/choose) specifying the technology you want to add. | Yes | | |
| | `filters.categories` | Array of strings | Specifies the list of categories that defines the type of tool. There are [predefined categories](https://github.com/asyncapi/website/blob/master/scripts/tools/categorylist.ts) in our documentation that you can use to list your tool under the proper category. If your tool doesn't matches with any categories specified in list, you can choose `others` option to list your tool. | Yes | | |
| | `filters.hasCommercial` | Boolean | Specifies whether the tool is a commercial product or open source. | No (`false` by default) | |
🧰 Tools
🪛 LanguageTool
[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)
🪛 markdownlint-cli2 (0.17.2)
63-63: Hard tabs
Column: 15
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 38
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 51
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 19
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 26
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 12
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 122
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 18
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 186
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 194
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 12
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 84
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 91
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 23
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 97
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 104
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 19
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 99
(MD010, no-hard-tabs)
69-69: Hard tabs
Column: 105
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 19
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 278
(MD010, no-hard-tabs)
70-70: Hard tabs
Column: 285
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 14
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 147
(MD010, no-hard-tabs)
71-71: Hard tabs
Column: 155
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 23
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 469
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 475
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 25
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 481
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 489
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 25
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 427
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 435
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 28
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 109
(MD010, no-hard-tabs)
75-75: Hard tabs
Column: 137
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md lines
63 to 75, the Markdown table uses hard tab characters to separate columns, which
can cause rendering issues. Replace all tab characters with spaces or use
consistent pipe and space characters to align the columns properly, ensuring the
table renders correctly across different Markdown viewers.
| | **Event** | **Description** | | | ||
| |-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------| | ||
| | **AsyncAPIConnect X (Twitter) Space//LinkedIn Live** | A webinar that provides an overview of AsyncAPI, its purpose, and how to get started | | | ||
| | **BuildBetter with AsyncAPI: Advanced AsyncAPI Usage** | Workshops focusing on more advanced usage and integrations of AsyncAPI | | | ||
| | **Contributing to AsyncAPI** | A guide to contributing to AsyncAPI, including coding standards, docs, design, GitHub usage, and community norms | | | ||
| | **AsyncAPI Ask Me Anything (AMA) Sessions** | Open Q&A sessions with core maintainers and community leaders | | ||
| | **AsyncAPI Podcast: The Future of APIs** | A monthly podcast to discuss API trends, event-driven architectures, AsyncAPI adoption, and real-world implementations. | | ||
|
|
There was a problem hiding this comment.
Table rows have too few cells – breaks rendering
Rows 63-67 only contain two cells while the header expects three (markdownlint MD056).
Add a third empty | or supply missing data to restore column alignment.
-| **AsyncAPIConnect X (Twitter) Space//LinkedIn Live** | A webinar ... |
+| **AsyncAPIConnect X (Twitter) Space / LinkedIn Live** | A webinar that provides an overview of AsyncAPI, its purpose, and how to get started | — |Fix all affected rows in this table.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
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)
🤖 Prompt for AI Agents
In
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
around lines 61 to 68, the table rows from 63 to 67 have only two cells while
the header expects three, causing rendering issues. Add a third empty cell by
appending an extra pipe character '|' at the end of each affected row to restore
proper column alignment and fix the markdownlint MD056 warning.
| 1. Log into [Restream.io](https://app.restream.io/home) and select `Set up for OBS, Zoom, etc.` option: | ||
|
|
||
| <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%"> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Provide descriptive alt text for embedded images
Every <img> tag lacks an alt attribute (MD045). This blocks screen-reader users and fails accessibility tooling.
Add concise alt text describing the screenshot’s purpose, e.g. alt="Restream dashboard – Setup for OBS".
(There are ~15 such occurrences throughout the doc.)
🧰 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)
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
between lines 45 and 59, all <img> tags are missing alt attributes, which is an
accessibility issue. Add concise and descriptive alt text to each <img> tag that
clearly describes the screenshot's purpose, such as alt="Restream dashboard –
Setup for OBS" for the first image, and similarly descriptive text for the
others.
akshatnema
deleted the
update-community-docs-f64840ea74a8700919edaca54edb0604ac468226
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Style