docs(community): update latest community documentation #4224
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
quetzalliwrites and
sambhavgupta0705
as code owners
WalkthroughThis update introduces a large set of new and revised community documentation files, including onboarding guides, contribution guidelines, governance policies, mentorship program details, project vision and marketing strategies, meeting organization, and style guides. It also updates configuration files and corrects minor formatting and linking issues in existing documents. Most changes are additive, expanding AsyncAPI's community documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Docs
participant Maintainers
participant TSC
participant Community
Contributor->>Docs: Reads onboarding/contribution/governance guides
Contributor->>Maintainers: Submits PRs/issues as per guidelines
Maintainers->>Docs: Updates/approves documentation and processes
Maintainers->>TSC: Escalates governance/voting/budget issues
TSC->>Docs: Updates governance, voting, and program docs
Contributor->>Community: Participates in meetings, mentorship, and programs
Community->>Docs: Provides feedback and suggestions
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
❌ Deploy Preview for asyncapi-website failed.
|
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 #4224 +/- ##
=========================================
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 (2)
config/edit-page-config.json (1)
15-33: Catch-all entry placed before specific community paths—rules will never match
determineEditLink()picks the first entry whosevaluematches the path.
Because the empty-string fallback ("value": "") is at lines 15-16, every path matches it and the newly-added community routes (lines 31-65) are effectively dead code.Move the fallback to the end of the array or delete it if another global fallback exists.
Also applies to: 59-65
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)
18-33: Table formatting issuesEvery row in the ideas table omits trailing pipes, so renderers collapse the cells and markdownlint raises MD055/MD056.
Align each row to the five-column header to ensure readability.
🧹 Nitpick comments (78)
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (4)
3-11: Punctuation & casing fixes
Small language nits that hurt readability:
• Line 3 – add a comma after “problem” (…to a problem, instead of…).
• Line 6 – lowercase “we” after the comma (…are "substantial," we ask…).
• Line 11 – serial comma after “document it,” (…explore the idea, document it, and create…).
These tweaks keep sentences grammatically correct.
16-24: Subject/verb agreement
Line 17: “The spec changes lifecycle consist of 2 parts” → “consists of two parts”.
Also prefer spelling out small numbers per style-guide.
21-23: Comma before coordinating “so”
Line 22: add a comma before “so” (…proposal, so the community…) to separate independent clauses.
45-50: Clarity & tone
Line 47: “Your contribution is made against thenext-specbranch” reads awkwardly; “Contributions must target thenext-specbranch” is clearer.
Line 49: “the world of open source won again” feels informal for governance docs—consider rephrasing to a neutral tone.markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
47-47: File-end newline removed—no impact
The deletion is harmless, but retain a trailing newline if you want to satisfy POSIX-style editors that expect one.markdown/docs/community/community-glossary.md (1)
1-3: Add front-matter & hide WIP pagesThe placeholder is fine, but without a front-matter header (
draft: true,title, etc.) the page will surface in navigation and SEO while empty, which hurts UX.
Consider adding minimal front-matter and/or marking the page as draft until content is ready.markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md (1)
1-3: Same WIP visibility concern as glossaryPlease add front-matter (
draft: trueorhidden: true) so half-finished pages do not appear in production menus or search results.markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md (1)
1-3: Hide unfinished roadmap until populatedRecommend adding front-matter with
draft: true(or moving to a private branch) to avoid broken navigation and reader confusion.markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
33-34: Mixed linking styles – use one conventionThe updated conventional-commits link now points to the GitHub source, while the earlier git-workflow link (line 28) is a root-relative path that will break on the website (
/asyncapi/...). Pick one approach:• Prefer full external URLs for GitHub docs, or
• Keep everything local and rely on the website’s routing.Staying consistent prevents future dead links.
markdown/docs/community/000-onboarding/how-to-contribute.md (1)
1-3: Placeholder page should not be published as-isPublishing an empty “🚧 under construction” stub negatively impacts user experience and SEO. Either:
- Provide at least a minimal outline (purpose, quick links, where to ask questions), or
- Omit the page from navigation until actual content is ready.
markdown/docs/community/070-marketing/social-media-communication-guidelines.md (1)
1-3: Remove or flesh-out the placeholderSame concern as the onboarding stub: the marketing section now surfaces an empty page that visitors will reach from the sidebar / search.
Consider hiding the file or adding a high-level outline (tone, target audiences, approval process) so the page provides some value immediately.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)
14-25: Minor Markdown polish•
MD034– wrap the bare URL in angle brackets (<url>) or use reference style to avoid raw links.
• Consider replacing “at-most-once, at-least-once” with “at most once / at least once” (LanguageTool false-positive).
•<del>tags inside tables render inconsistently across GitHub-flavored Markdown; strike-through via~~is more portable.markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (2)
7-9: Heading level jumps (MD001)
### Key Responsibilitiesshould be## Key Responsibilitiesto follow the h1 → h2 progression.
11-15: Repetition and lengthThe bullet at lines 11-15 repeats “You’ll need to” three times and spans ~3 sentences. Tightening the wording improves readability.
Example rewrite (no need to commit verbatim):
“Provide guidance and set clear goals and milestones. Encourage collaboration among contributors and mentors, and keep project documentation up to date.”
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (3)
1-2: Fix typos and convert bare URL to Markdown link– “annoucement” → “announcement”
– Wrap the discussion URL in[]()to silence MD034.
These tiny fixes remove lint warnings and improve readability.
11-13: Correct invalid ordinal “23th January”Change to “23rd January” to match English ordinal rules and silence LanguageTool’s ORDINAL_NUMBER_SUFFIX warning.
25-32: Normalise table pipe style and spelling
- Add trailing pipes so the table passes MD055.
- Entry 30: “formate” → “format”, “AsyncAPi” → “AsyncAPI”.
- Entry 31: Capitalise “URL” and prepend “the” (“update the URL of Studio…”).
Minor polish keeps docs lint-clean and professional.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (3)
1-8: Heading hierarchy & title wording– Title should be “## Project ideas” (h2) so heading levels increment by one (MD001).
– Singular “Project” reads better than “Projects”.
Implementing this resolves the heading-increment linter error.
11-14: Tighten wording and fix spelling– Replace informal “diff protocols” with “different protocols”.
– Remove comma before “because” (LanguageTool COMMA_BEFORE_BECAUSE).
– NodeJS → Node.js; “engile” → “engine”.
These small edits boost clarity and accuracy.
14-18: Consistency: capitalisation & phrasing– Avoid “hard to” → “difficult to”.
– Maintain U.S. spelling: choose “visualizer” everywhere (entry 27 currently mixes).
– Use stronger adjective than “good” in entry 20 (“robust solution”, for example).
Addresses multiple LanguageTool style hints.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md (2)
11-13: Blank lines required around tableInsert a blank line before and after the table block to comply with MD058 (
blanks-around-tables).
18-18: Use official spelling “Node.js”Change “NodeJS” → “Node.js” for accuracy and consistency across docs.
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (2)
7-9: Adjust heading level
### Contact informationshould be## Contact information(and similarly for subsequent sections) to keep heading levels sequential (MD001).
30-32: Grammar & punctuation touches– Add comma after “Git” → “Git, (a plus …)”.
– “independently from” → “independently of”.
These fixes resolve LanguageTool flags.markdown/docs/community/040-guides/keep-repository-settings-consistent.md (2)
11-11: Insert missing articleAdd “the” before Sponsorships:
“Make sure the Sponsorships option is selected …”
Silences AI_EN_LECTOR_MISSING_DETERMINER_THE warning and reads naturally.
29-31: Subject-verb agreementSentence currently reads “global workflows cover mostly all the needs”.
Swap to “cover most of the needs” or “covers most needs” to satisfy agreement and improve flow.markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (2)
9-10: Typo in Twitter handle
derberqlooks like a typo for Lukasz Gornicki’s handle (derberg).
Fixing it ensures readers reach the correct profile.
18-24: Comma splice and en-dash formattingSentence “In 2022, GSoD at AsyncAPI had 2 projects and we hired 6 Technical Writers” joins two independent clauses without a comma; also use an en-dash in “June – August”. Small polish, but it improves professionalism and passes LanguageTool checks.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)
3-8: Heading level jumps
## Timelineshould be H2, not H3 (MD001). Adjust heading levels so they increment sequentially.markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (2)
7-15: Minor style and tense improvements
- “You come up with the idea that we used to do something great” reads awkwardly; consider present tense (“that we use to …”).
- “many different ways” can be shortened to “many ways”.
Polishing wording strengthens the guideline’s clarity.
26-35: Fix emphasis spacing & bare URLs
MD037flags spaces inside the emphasis markers in the emoji key note, andMD034flags bare URLs. Wrap URLs in<>or convert to Markdown links to silence linter warnings.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
12-12: Fix typo in list item
Specifing→Specifyingfor correctness and polish.
21-22: Plural noun missing
“specify thing that are common” → “specify things that are common” reads better and avoids a grammar stumble.markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (2)
11-15: Minor formatting & comma
Insert a blank line before# Blog post requirements, and add a comma after “maintainers” to separate clauses cleanly.
18-20: Replace bare URL with markdown link
https://squoosh.appsurfaces MD034; wrap it as[Squoosh](https://squoosh.app)to satisfy markdown-lint.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (3)
9-10: Grammar: remove extra “the”
“…is the one of the most used protocols…” → “…is one of the most used protocols…”.
14-14: Use official styling
Replace every “NodeJS” with “Node.js” to match the framework’s official spelling.
15-16: Dangling infinitive
“should allow to build” → “should allow users to build” for natural English.markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (4)
26-31: Plural-singular mismatch in section intro.The phrase “type of contributions” should agree in number with the plural noun it introduces (“types of contributions”) or be re-worded (“this type of contribution”).
37-38: Article + tense consistency.“accepted as ambassador” → “accepted as an ambassador” to keep the article and noun form consistent with earlier bullet points.
41-44: Wordiness.“Be in tune with AsyncAPI’s mission and values.” → “Align with AsyncAPI’s mission and values.” Shorter and clearer.
63-67: Preposition and number choice.“finds themselves in the members list” → “on the members list”;
“Presses on their handle” → usually “clicks their handle”.markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (2)
41-48: TailwindCSS bullet lacks serial comma – possible ambiguity.Consider “JavaScript, React, Storybook, and Tailwind CSS” for consistency with other lists.
67-70: Missing preposition.“Join our Slack workspace” → usually “Join us on our Slack workspace” or simply “Join our Slack workspace”. Double-check phrasing.
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (2)
25-27: Table needs blank lines for markdown-lint.
markdownlintflags MD058; add a blank line before and after the table to avoid rendering issues on some engines.
5-21: Use en-dashes for date ranges.Examples: “February 22 – March 18” instead of “February 22 - March 18”. Keeps typography consistent across docs.
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (2)
44-46: Compound adjective needs hyphen.“Open Source Contribution” is a noun phrase; if intended as an adjective before “experience” or similar, use “open-source contribution”. Verify intent.
86-88: Missing preposition.Same Slack sentence as 2024 page: consider “Join us on our Slack workspace” or drop “us”.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (2)
50-60: Long sentence – readability + typos.“decisions making process” → “decision-making process”;
“checkes” → “checks”;
Consider splitting the long bullet into two sentences for clarity.
76-90: In-the-website phrasing & verb agreement.“refactoring of the website” (or “in the website codebase”), and “tests on it” → “tests for it”. Improves English idiom.
markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (2)
32-34: Incorrect inline-code delimiter renders literally instead of formatting
The text says “Use backticks (``) for code…”, but the example uses a pair of consecutive grave accents instead of the required single back-tick. Readers will see two back-ticks instead of formatted code.Consider re-phrasing to:
Use back-ticks (\) for code …`
36-37: Channel-prefix example contradicts its own rule
You state that only officially maintained channels use theN_numeric prefix, yet the example tells users creating a channel to “feel free” but “don't use numeric prefixes”. The wording is ambiguous and may confuse new contributors.Suggest splitting into two sentences—one describing official prefixes, another explicitly instructing users not to create channels starting with a number.
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (4)
13-14: Typos: “Specifing” ➜ “Specifying” & “reuse schema from components.”
Small spelling and agreement issues in the bullet list describing document sections.Fixing keeps the proposal polished and professional.
Also applies to: 17-18
24-29: Double space creates odd wrap in rendered Markdown
“create a learning experience”has two spaces after “a”. It shows as an unexpected break in some renderers.Delete the extra space to avoid layout hiccups.
44-50: Ranges should use an en-dash instead of hyphen for clarity
“4-6 months”, “June - August”, “September - October” ⇒ “4–6 months”, “June – August”, etc. This is consistent with the rest of AsyncAPI docs style.Purely editorial.
54-61: Currency duplication: “$350 dollars”
Remove the word “dollars” (the$already implies USD) to avoid redundancy.Also update table header totals accordingly.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
43-44: Missing comma after “For example”
Markdown renders fine, but the sentence reads smoother with the standard “For example, see…”.Tiny grammar tweak.
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1)
5-5: Grammar: missing comma after “responds to”
Should read “responds to, investigates, and resolves …”.Quick copy-edit avoids confusion at the very first definition line.
markdown/docs/community/020-governance-and-policies/donating-projects.md (2)
4-6: Missing definite article
“AsyncAPI initiative is open…” → “The AsyncAPI Initiative is open…”.Minor but aligns with branding seen elsewhere in the docs.
37-41: Comma before essential ‘because’ clause
Sentence currently reads “…ask for a vote on migrating your project to the organization, because the Technical Steering Committee…”.
The comma implies the clause is non-essential, but it is critical context.Removing the comma improves flow.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
47-51: Minor grammar & article usage
"synchronize master branch of your fork"→ synchronize the master branch of your fork (or main after renaming).
Tiny nit, but worth polishing in a canonical guide.markdown/docs/community/050-mentorship-program/summerofcode/README.md (1)
3-3: Heading level jumps from H1 → H6Markdown-lint flags
###### Introductionimmediately after the H1.
Increment levels sequentially (H2 here) to maintain accessibility and correct document outline.markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1)
16-17: Add missing determiners for clarity“in same repository” → “in the same repository”;
“provide correctrepoUrl” → “provide the correctrepoUrl”.It reads smoother and avoids ambiguity.
markdown/docs/community/020-governance-and-policies/voting.md (1)
20-26: Quorum sentence is mathematically unclear“51 % multiplied by 40” conveys the idea but is imprecise.
Consider rephrasing:Quorum equals a simple majority of current TSC members (e.g. 21 of 40).
This avoids readers assuming an exact 51 % requirement instead of “> 50 %”.
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
24-26: Long sentence needs commas for readabilityLines 24-25 are a 60-word run-on sentence. Insert commas or split into two sentences to help non-native readers parse the idea.
markdown/docs/community/styleguide/version-control.md (1)
57-59: Remove the double-space and keep the heading style consistent
### When Submitting Changescontains two consecutive spaces after “Submitting”.
For consistency with the rest of the document headings, collapse the spaces to one (or rename to “### When submitting changes”).markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (1)
106-109: Minor wording – add an article and rephrase
Write email to info@asyncapi.io.→ “Write an email to info@asyncapi.io.”
Small polish that reads more naturally.markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (2)
66-70: Typo: “emojies” → “emojis”The plural form is “emojis”. Also consider adding a short note that only those three reactions are recognised by
gitvote.
82-84: “Master ceremony” appears to be “Master of Ceremonies”“help with the Master ceremony”
Unless this is a project-specific term, use “Master of Ceremonies” or “emcee” for clarity.
markdown/docs/community/onboarding-guide/github-actions.md (1)
72-76: Capitalize “Node.js”Markdown-lint flagged the lowercase
nodejs. Use the correct product spelling: “Node.js”.markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (2)
7-8: Prefer concise adverb form (“transparently”).The clause “…the group works in a transparent manner” is wordy. Replacing it with “works transparently” conveys the same idea more succinctly.
30-33: Minor naming & casing tweaks for Slack references.In the bullet list the key names use the lowercase prefix
slack.but the accompanying text says “Slack channel” / “Slack handle”. Consider:
- Capitalising “Slack” in the key names to avoid confusion (
slack.group.handle → slack.groupHandle, or similar)- Removing the back-ticks around the example channel/handle so that Markdown renders them as plain text links when copied.
These tweaks improve clarity while remaining consistent with the rest of the docs.markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (2)
31-33: Fix missing space after period and break long sentence.
“…we can record and build upon.Once we have some onboarding available, we should…”– add a space after the period and consider splitting into two sentences for readability.
28-29: Colloquial phrasing – consider re-wording.“Maybe do research by reaching out to the current TSC members…” is informal for a strategy document. A more assertive alternative: “Research by contacting current TSC members and maintainers from corporate backgrounds.”
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (4)
13-14: Hyphenate compound adjective & tighten wording.“open source maintainers and contributors of Middle and Senior professional levels” →
“open-source maintainers and contributors at mid- and senior-level.”This small change reads more naturally while keeping the original meaning intact.
124-127: Comma placement inside parenthesis.The comma after the closing parenthesis in
…or earlier,) they are pinged…breaks the sentence flow; move it outside the parenthesis or drop it.
130-131: Missing comma before coordinating conjunction.
“…Participants and the End Of Life rules…”joins two independent clauses with “and”. Insert a comma before “and” for correct punctuation.
182-183: Use “cannot” instead of “can not”.Standard English contracts “can not” to “cannot” unless the writer is intentionally emphasising “not”.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (59)
config/edit-page-config.json(1 hunks)markdown/docs/community/000-onboarding/docs-onboarding-checklist.md(1 hunks)markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md(1 hunks)markdown/docs/community/000-onboarding/how-to-contribute.md(1 hunks)markdown/docs/community/000-onboarding/where-to-contribute.md(1 hunks)markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md(1 hunks)markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md(1 hunks)markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribution-flow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/git-workflow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognize-contributors.md(1 hunks)markdown/docs/community/011-styleguide/grammar.md(1 hunks)markdown/docs/community/011-styleguide/numbers.md(1 hunks)markdown/docs/community/020-governance-and-policies/CHARTER.md(1 hunks)markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md(1 hunks)markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md(1 hunks)markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md(1 hunks)markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md(1 hunks)markdown/docs/community/020-governance-and-policies/donating-projects.md(1 hunks)markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md(1 hunks)markdown/docs/community/020-governance-and-policies/voting.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md(1 hunks)markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md(1 hunks)markdown/docs/community/040-guides/keep-repository-settings-consistent.md(1 hunks)markdown/docs/community/050-mentorship-program/README.md(1 hunks)markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/application-template.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md(1 hunks)markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md(1 hunks)markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)markdown/docs/community/060-meetings-and-communication/slack-etiquette.md(1 hunks)markdown/docs/community/070-marketing/social-media-communication-guidelines.md(1 hunks)markdown/docs/community/COC-incident-resolution-procedures.md(1 hunks)markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md(1 hunks)markdown/docs/community/community-glossary.md(1 hunks)markdown/docs/community/onboarding-guide/github-actions.md(1 hunks)markdown/docs/community/onboarding-guide/identifying-good-first-issues.md(1 hunks)markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md(1 hunks)markdown/docs/community/styleguide/version-control.md(1 hunks)
🧰 Additional context used
🧠 Learnings (20)
📓 Common learnings
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.
Learnt from: 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/000-onboarding/docs-onboarding-checklist.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: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
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-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: 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: 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 (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/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (4)
Learnt from: iambami
PR: asyncapi/website#4111
File: markdown/blog/community-spotlight-aayush.md:3-3
Timestamp: 2025-06-03T06:48:09.304Z
Learning: For AsyncAPI community spotlight blog posts, the frontmatter date should reflect the actual publication date, not the month being highlighted in the spotlight. For example, a "May Community Spotlight" can be published in June with a June date in the frontmatter.
Learnt from: Siddhant-Pragyan-Sinha
PR: asyncapi/website#4074
File: markdown/blog/open-nest.md:11-12
Timestamp: 2025-04-28T01:13:59.084Z
Learning: For AsyncAPI blog posts, author photo filenames don't necessarily need to match the author's official name, as some authors may use pen names or nicknames (e.g., Aishat Muibudeen using "maya_picture.webp" for her avatar).
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/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/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (3)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.
Learnt from: akshatnema
PR: asyncapi/website#3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.
Learnt from: akshatnema
PR: asyncapi/website#3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the `tests/fixtures/tools/automated-tools.json` file, the `language` field within the `filters` object can be either a string or an array. Both formats are acceptable and supported in the codebase.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (2)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (3)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: 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: 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/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/styleguide/version-control.md (1)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/010-contribution-guidelines/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/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}"
```
🪛 LanguageTool
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...google.github.io/gsocguides/mentor/) - [Open Source Best Practices](https://opensource.guid...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/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/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/recognize-contributors.md
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: .../master/README.md#contributors). We use [All Contributors](https://allcontributor...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~9-~9: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...lack-invite) or some other channel. You come up with the idea that we used to do som...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[style] ~11-~11: Consider replacing this word to strengthen your wording.
Context: ...ull requests. You are a language expert and can review docs or an expert in a speci...
(AND_THAT)
[style] ~15-~15: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: ...ues or in Slack You can help us out in many different ways. Just check out [this](https://allcontr...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~17-~17: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... if we failed in recognizing your work. Feel free to contact us on [slack](https://asyncapi....
(FEEL_FREE_TO_STYLE_ME)
[uncategorized] ~21-~21: Possible missing article found.
Context: ...To recognize work, after it is done, in closed issue or pull request, add a proper com...
(AI_HYDRA_LEO_MISSING_A)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
[style] ~13-~13: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...communication is also essential. You'll need to communicate effectively with your contr...
(REP_NEED_TO_VB)
[style] ~13-~13: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ...ructive feedback, and help contributors improve their coding skills. - Please also enc...
(IMPROVE_STRENGTHEN)
markdown/docs/community/050-mentorship-program/README.md
[style] ~3-~3: Consider using a more concise synonym.
Context: ...The AsyncAPI Initiative participates in a variety of mentoring programs. AsyncAPI is a great...
(A_VARIETY_OF)
markdown/docs/community/050-mentorship-program/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/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/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/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/040-guides/keep-repository-settings-consistent.md
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...: - Wikis - Projects Make sure Sponsorships option is selected and `...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~29-~29: This verb does not appear to agree with the subject. Consider using a different form.
Context: .../.github/tree/master/.github/workflows) cover mostly all the needs for most of the re...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
markdown/docs/community/050-mentorship-program/summerofcode/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/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/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/voting.md
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...b.com/asyncapi/community) repository. - Voting automation works only with GitHub Issue...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~14-~14: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... Pull Requests. The Discussions should only be used for initial discussion, brainst...
(ONLY_EXCLUSIVELY_STYLE)
[uncategorized] ~22-~22: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... with 👀 to indicate that you saw a vote but you have no opinion, or cannot make a p...
(COMMA_COMPOUND_SENTENCE)
markdown/docs/community/050-mentorship-program/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/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/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/seasonofdocs/2023/README.md
[uncategorized] ~20-~20: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...how trait concepts work. - Organizing document with tags - Explain different tags in...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[typographical] ~44-~44: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...ine The project will take approximately 4-6 months to complete, depending on the di...
(HYPHEN_TO_EN)
[style] ~44-~44: Consider using an alternative to strengthen your wording.
Context: ...at might get involved. (At AsyncAPI, we want to work with any TW, regardless of thei...
(WANT_KEEN)
[style] ~44-~44: Consider using a different adverb to strengthen your wording.
Context: ...look forward to mentoring TW(s) who are completely new to tech and making them feel welcom...
(COMPLETELY_ENTIRELY)
[typographical] ~48-~48: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ch new TW contributor started. - June - August: Each TW goes through designate...
(DASH_RULE)
[typographical] ~49-~49: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...issues assigned/selected. - September - October: We determine if we can comple...
(DASH_RULE)
[typographical] ~54-~54: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... ### 💸 Project budget We'll set aside 2-3 mentors for our two proposed projects: ...
(HYPHEN_TO_EN)
[uncategorized] ~54-~54: If this is a question, use a question mark.
Context: ...oogle a US $5000 budget for each project. For both projects, the request then tot...
(QUESTION_MARK)
[style] ~54-~54: Consider using “350” only; there is no need for the currency symbol because ‘dollars’ follows.
Context: ...ould also like to request an additional $350 dollars in our budget to provide cool s...
(REPEATED_CURRENCY)
markdown/docs/community/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/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/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/020-governance-and-policies/CHARTER.md
[style] ~36-~36: Consider a more concise word here.
Context: ...ze of TSC. The size is expected to vary in order to ensure adequate coverage of important a...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...mbassadors. The TSC may adopt or modify roles so long as the roles are documented in ...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~49-~49: This word is normally spelled as one.
Context: ...cubation, deprecation, and changes to a sub-project’s scope); 3. Organizing sub-project...
(EN_COMPOUNDS_SUB_PROJECT)
[misspelling] ~50-~50: This word is normally spelled as one.
Context: ...sub-project’s scope); 3. Organizing sub-projects and removing sub-projects; 4. Creat...
(EN_COMPOUNDS_SUB_PROJECTS)
[misspelling] ~50-~50: This word is normally spelled as one.
Context: ...3. Organizing sub-projects and removing sub-projects; 4. Creating sub-committees or work...
(EN_COMPOUNDS_SUB_PROJECTS)
[misspelling] ~51-~51: This word is normally spelled as one.
Context: ... removing sub-projects; 4. Creating sub-committees or working groups to focus on cross-pro...
(EN_COMPOUNDS_SUB_COMMITTEES)
[typographical] ~56-~56: Conjunctions like ‘and’ should not follow semicolons. Consider using a comma, or removing the conjunction.
Context: ... code base that affect multiple projects; and 10. Coordinating any marketing, events, or...
(CONJUNCTION_AFTER_SEMICOLON)
[uncategorized] ~63-~63: You might be missing the article “a” here.
Context: ...t. 3. The Board members are elected for 24-month cadence. 4. The Board members MUST be T...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[style] ~67-~67: ‘a majority of the’ might be wordy. Consider a shorter alternative.
Context: ...can only be removed upon resignation or a majority of the TSC votes. Next steps will be specified...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF_THE)
[uncategorized] ~69-~69: You might be missing the article “the” here.
Context: ...t. 9. The Board chairperson coordinates work of the board and ensures it operates ef...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~93-~93: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...rovided in Section 6, decisions require a majority of votes. 4. Decisions must always be made...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~101-~101: You might be missing the article “a” here.
Context: ... will be conducted without the need for quorum, and only two-thirds of the votes will ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cribe the contribution, the alternative open source license(s), and the justification for u...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... justification for using an alternative open source license for the Project. License except...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~119-~119: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...ject to approval by the Series Manager. In the event that a Project-specific CoC has not been app...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
[style] ~120-~120: Nowadays, it’s more common to write this as one word.
Context: ...cy, as to be amended or adopted, on its web site at least 30 days prior to such policy t...
(RECOMMENDED_COMPOUNDS)
[style] ~120-~120: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...opted, on its web site at least 30 days prior to such policy taking effect; provided, ho...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~120-~120: Nowadays, it’s more common to write this as one word.
Context: ...ective upon publication on LF Project’s web site. 4. All Collaborators must allow open p...
(RECOMMENDED_COMPOUNDS)
[style] ~127-~127: Consider replacing this phrase with the adverb “professionally” to avoid wordiness.
Context: ... 1. Engage in the work of the Project in a professional manner consistent with maintaining a cohesive ...
(IN_A_X_MANNER)
markdown/docs/community/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/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[uncategorized] ~9-~9: You might be missing the article “the” here.
Context: ...ngs, live transcripts, and streaming. - GitHub Action workflow for Ad Hoc meeting sc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[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)
[uncategorized] ~64-~64: You might be missing the article “the” here.
Context: ...m1.png) 1. Confirm transcriptions with Enable button: 
[uncategorized] ~72-~72: You might be missing the article “the” here.
Context: ..../assets/meetings/zoom3.png) 1. Select Live on Custom Live Stream Service opti...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...ttps://app.restream.io/home) and select Start with Studio option: <img src...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[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] ~168-~168: You might be missing the article “the” here.
Context: ...endez` so he can give you access to all required tools. ## How do I publish broadcast...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~189-~189: You might be missing the article “a” here.
Context: ...d to trigger the workflow. ### What is YouTube video ID? - A YouTube video ID is a un...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[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)
[uncategorized] ~228-~228: You might be missing the article “the” here.
Context: ... the YouTube ID in the box. 6. Click on Run workflow button. 7. Wait for the w...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~229-~229: You might be missing the article “the” here.
Context: ...r the workflow to finish. (Depending on video size, it may take some time to upload, ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~236-~236: You might be missing the article “the” here.
Context: ... Login using AsyncAPI account. 2. Go to Episodes section. There, you will see y...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
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/060-meetings-and-communication/slack-etiquette.md
[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...ng to Slack Etiquette' weight: 170 --- AsyncAPI Community uses Slack for real-time conv...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ... replies to your question, respond in a thread unless they've already moved it elsewhe...
(AI_HYDRA_LEO_MISSING_COMMA)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...butors that are not affiliated with any company willing to help the AsyncAPI Initiative...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~47-~47: If the word ‘do’ starts a question (or is part of a question), add a question mark (“?”) at the end of the sentence.
Context: ...on why do we want to be that transparent. ## Duties TSC members have two primar...
(PCT_DO_QUESTION_MARK)
[uncategorized] ~52-~52: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...s have two primary duties: 1. Regularly participate in TSC discussions and voting. 2. Alway...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[style] ~53-~53: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...iscussions and voting. 2. Always behave with respect to [AsyncAPI Code of Conduct](https://gith...
(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
[style] ~58-~58: Consider using an alternative to strengthen your wording.
Context: ... - when an existing open-source project wants to join the AsyncAPI umbrella (owner wa...
(WANT_KEEN)
[style] ~58-~58: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ts to join the AsyncAPI umbrella (owner wants to donate the project to the AsyncAPI Init...
(REP_WANT_TO_VB)
[uncategorized] ~82-~82: The preposition ‘to’ seems more likely in this position.
Context: ...e else. * TSC members are first asked for help with the Master ceremony, exposing...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[uncategorized] ~88-~88: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the most trusted group in the community and it is the first group of people to choo...
(COMMA_COMPOUND_SENTENCE)
markdown/docs/community/onboarding-guide/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/020-governance-and-policies/donating-projects.md
[uncategorized] ~4-~4: You might be missing the article “the” here.
Context: ...ligns it with broader community goals. AsyncAPI initiative is open to receiving project...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...r both maintainers and contributors. - We make Intellectual Property (IP) Review ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[formatting] ~38-~38: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...grating your project to the organization, because the Technical Steering Committee (TSC) ...
(COMMA_BEFORE_BECAUSE)
[grammar] ~48-~48: If the situation that you’re describing is mandatory or essential, you can use the subjunctive mood here.
Context: ..., it's essential that the documentation reflects these changes accurately to assist both...
(SUBJUNCTIVE_MOOD)
markdown/docs/community/020-governance-and-policies/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/CODE_OF_CONDUCT_COMMITTEE.md
[style] ~28-~28: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...manent action shall require approval of a majority of non-conflicted members of the CoC Commi...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~28-~28: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...ee may take action without a meeting if a majority of non-conflicted members express agreemen...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~28-~28: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... quorum of the non-conflicted members. A majority of non-conflicted members shall be deemed ...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
markdown/docs/community/050-mentorship-program/summerofcode/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/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/010-contribution-guidelines/git-workflow.md
[uncategorized] ~50-~50: Possible missing comma found.
Context: ...y to understand all the steps. > > Next time you can write a script to synchronize m...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ...e you can write a script to synchronize master branch of your fork with the master bra...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ... of your fork with the master branch of upstream git repository. Check [this script](htt...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...t. The main purpose of such a tool is a changelog where you can present to the user what ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ..., but not as pointing what lines changed but in general what objects changed. So if ...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~24-~24: Consider adding a comma after this introductory phrase.
Context: ...t as pointing what lines changed but in general what objects changed. So if there was a...
(IN_GENERAL_COMMA)
[uncategorized] ~24-~24: You might be missing the article “the” here.
Context: ...s changed. So if there was an update in payload, the library must specify what channel ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ... in what message got updated (with json pointers most probably). You can familiarize wit...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~25-~25: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ions. We already started work on the CLI so before summer there will be enough to p...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~42-~42: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ject. We already started work on the CLI so before summer there will be enough to p...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~56-~56: You might be missing the article “a” here.
Context: ...ve to first onboard on the project with few basic tasks handed over by the mentor. ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~62-~62: Possible missing comma found.
Context: ...expert. Based on a set of questions and answers it should generate an AsyncAPI document...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...r the user. Example conversation: (real-time we show a preview of the AsyncAPI docum...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~76-~76: ‘a’ may be redundant when used with the uncountable noun ‘knowledge’.
Context: ...edge: This project requires you to have a basic knowledge about the location of spec related mate...
(A_UNCOUNTABLE_NOUN)
[uncategorized] ~76-~76: A comma might be missing here.
Context: ...what is missing to make it possible. As prerequisite you of course need to read about curren...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~76-~76: Consider adding two commas here.
Context: ...to make it possible. As prerequisite you of course need to read about current technologies...
(OF_COURSE_COMMA)
[style] ~76-~76: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...possible. As prerequisite you of course need to read about current technologies that ar...
(REP_NEED_TO_VB)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ...up environments with Docker compose and mocks and a proper testing environment will h...
(AI_HYDRA_LEO_MISSING_COMMA)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
[uncategorized] ~50-~50: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ors can connect and collaborate.
- Open Source Contributions: Encourage contributions ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~53-~53: There may an error in the verb form ‘be inform’.
Context: ...y, in-depth video tutorials. This could be inform of the Bounty Program.
- Online Le...
(MD_BE_NON_VBP)
[uncategorized] ~84-~84: Possible missing article found.
Context: ...ubscription and participation - Publish marketing blog every quater detailing the activit...
(AI_HYDRA_LEO_MISSING_A)
[style] ~102-~102: This phrase is redundant (‘O’ stands for ‘Optimization’). Use simply “SEO”.
Context: ... | ## Website Traffic Growth ### SEO Optimization - Improve AsyncAPI website SEO with hi...
(ACRONYM_TAUTOLOGY)
[uncategorized] ~136-~136: You might be missing the article “the” here.
Context: ...ewsletter", linking to subscribe. - Ask community to promote the newsletter to their audi...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~156-~156: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... | The views per month, and the new subscriber. 20% increase quarter | | **Website Tra...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
markdown/docs/community/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/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/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/onboarding-guide/github-actions.md
[uncategorized] ~49-~49: A punctuation mark might be missing here.
Context: ...bal GitHub Actions workflows inside the [.github](https://github.com/asyncapi/....
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~74-~74: The official spelling of this programming framework is “Node.js”.
Context: ...ften uses GitHub Topics (like golang, nodejs, or docker) to decide which reposito...
(NODE_JS)
[style] ~99-~99: Consider a more expressive alternative.
Context: ...r to trigger it manually for you. To do this, reach out on Slack or open an iss...
(DO_ACHIEVE)
markdown/docs/community/020-governance-and-policies/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/010-contribution-guidelines/BOUNTY_PROGRAM.md
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s its main purpose rewarding individual open source maintainers and contributors of **Middl...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~75-~75: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uld be explicitly stated in the Scope. In case two Bounty Issues are inextricably...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~77-~77: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ust be explicitly stated in the Scope. In case the total reward for all submitted...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~98-~98: Possible missing comma found.
Context: ...gram is counted from Monday of the next week when assignment of the Bounty Issue on ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~106-~106: Possible missing article found.
Context: ...and the start of its merging process - Final Pull Request must be submitted, and its...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~112-~112: Possible missing article found.
Context: ...and the start of its merging process - Final Pull Request must be submitted, and its...
(AI_HYDRA_LEO_MISSING_A)
[style] ~124-~124: Consider simply using “of” instead.
Context: ...nty Issue (on Monday, the last activity of any of the abovementioned types was four or mo...
(OF_ANY_OF)
[uncategorized] ~124-~124: Commas should not be placed before a closing parenthesis. Either move the comma outside of the parentheses, or remove it altogether.
Context: ...vity of any type was on 2024-05-16 or earlier,) they are pinged as a reminder to do so....
(COMMA_CLOSING_PARENTHESIS)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...ules are applied to such Bounty Program Participants and the End Of Life rules to such Bount...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~147-~147: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... Issue Timeline extension should happen prior to any current milestone of the Bounty Iss...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~159-~159: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...as already acquired an obligation to pay but factually the conditions of the Bounty ...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~173-~173: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ered the one that reached End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~175-~175: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the one that reached the End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~177-~177: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ered the one that reached End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~182-~182: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ssue Candidate. A dropped Bounty Issue can not be assigned again to the same Bounty Pr...
(CAN_NOT_PREMIUM)
[uncategorized] ~188-~188: Possible missing article found.
Context: ...Bounty Issues submitted by themselves. Bounty Program Participant is allowed to choos...
(AI_HYDRA_LEO_MISSING_A)
[style] ~195-~195: The phrase “taken into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...solution of the Bounty Issue, etc.) are taken into consideration only if they occurred after the additio...
(TAKE_INTO_CONSIDERATION)
[uncategorized] ~196-~196: You might be missing the article “the” here.
Context: ...ub label bounty to the GitHub issue. GitHub label bounty has hex code #0E8A16. ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~216-~216: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...elies on Open Collective's Fiscal Host 'Open Source Collective' to service payments and, th...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~216-~216: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...er they will be able to receive payment prior to starting participation in the Bounty Pr...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~216-~216: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...*. AsyncAPI will not take any action if Open Source Collective refuses to relay the payment...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~218-~218: Commas should not be placed before a closing parenthesis. Either move the comma outside of the parentheses, or remove it altogether.
Context: ...scal Host in the US (AsyncAPI fits this description,) they will be asked to fill out an IRS t...
(COMMA_CLOSING_PARENTHESIS)
[uncategorized] ~220-~220: Possible missing article found.
Context: ...In rare cases (once per calendar year), Bounty Program Participant in personal communi...
(AI_HYDRA_LEO_MISSING_A)
🪛 markdownlint-cli2 (0.17.2)
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/010-contribution-guidelines/recognize-contributors.md
26-26: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
26-26: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
33-33: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/README.md
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
6-6: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
8-8: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
8-8: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
8-8: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
11-11: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
11-11: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
11-11: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
25-25: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md
21-21: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/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/2024/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/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/020-governance-and-policies/voting.md
35-35: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
6-6: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
8-8: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
8-8: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
8-8: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
11-11: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
11-11: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
11-11: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
25-25: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
43-43: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
64-64: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
78-78: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
112-112: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
114-114: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
115-115: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
120-120: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
123-123: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
markdown/docs/community/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/seasonofdocs/2023/README.md
48-48: Hard tabs
Column: 21
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 32
(MD010, no-hard-tabs)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/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/COC-incident-resolution-procedures.md
12-12: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
12-12: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
13-13: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
13-13: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
14-14: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
15-15: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
15-15: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
16-16: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 4; Actual: 3
(MD007, ul-indent)
21-21: Hard tabs
Column: 3
(MD010, no-hard-tabs)
22-22: Inconsistent indentation for list items at the same level
Expected: 3; Actual: 2
(MD005, list-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
22-22: Hard tabs
Column: 1
(MD010, no-hard-tabs)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
22-22: 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/summerofcode/README.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h6
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md
25-25: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
25-25: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
22-22: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
26-26: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
26-26: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
33-33: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
64-64: Bare URL used
(MD034, no-bare-urls)
92-92: Bare URL used
(MD034, no-bare-urls)
208-208: Bare URL used
(MD034, no-bare-urls)
248-248: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
248-248: Bare URL used
(MD034, no-bare-urls)
249-249: Bare URL used
(MD034, no-bare-urls)
250-250: Bare URL used
(MD034, no-bare-urls)
251-251: Bare URL used
(MD034, no-bare-urls)
252-252: Bare URL used
(MD034, no-bare-urls)
253-253: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (17)
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
99-101: Bullet formatting fixed correctly
Removing the stray hyphen restores proper Markdown list syntax and avoids unintended rendering artifacts.markdown/docs/community/011-styleguide/numbers.md (1)
158-159: Whitespace cleanup is fine
Trailing-space removal keeps the file tidy and avoids spurious Git diffs. Nothing else to flag here.markdown/docs/community/011-styleguide/grammar.md (1)
73-76: Indentation aligned correctly
Removing the stray leading space before the “Microsoft Style Guide” bullet restores proper list formatting. Looks good.markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
15-16: Relative links validated—no changes neededThe referenced files exist with matching slugs under
markdown/docs/community/010-contribution-guidelines/, so Gatsby/Next will correctly resolve the URLs without the.mdextension:
- markdown/docs/community/010-contribution-guidelines/technical-writer-contributor-responsibilities.md
- markdown/docs/community/010-contribution-guidelines/prerequisite-knowledge.md
markdown/docs/community/050-mentorship-program/README.md (1)
29-41: Statistics table is malformedRows 34 and 37 have only three cells, and row 39 embeds the program name in the year-column cell.
Double-check the intended layout and ensure each row contains exactly four pipes so automated tools and readers render it correctly.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)
14-22: Inconsistent casing & incorrect GitHub handlesRows 19–21 mix cases (
AceTheCreatorvsacethecreator) and list mismatched handles (Iván García … → ibishal). Verify each mentor/mentee link and use canonical casing to avoid broken references.markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
47-49: Verify target URL and avoid bare-link lint error
The pathcode_of_conduct/code-of-conduct-committee.mdmay not exist (other docs useCODE_OF_CONDUCT_COMMITTEE.md). Double-check the link and consider a relative path to silence MD034.markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (1)
1-3: No actionable feedback—auto-generated file
Looks machine-generated and already flagged as such. Nothing to review.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (1)
13-14: Typo & wording
“specified broken” appears to be “specified broker” (or environment). Clarify to avoid confusion.markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (1)
56-60: Minor clarity & missing article.Line 56: “very simple” can be dropped without loss of meaning.
Line 59: “to form a link similar to …” – missing article.markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (1)
62-63: Official spelling “Node.js”.Replace “Node js” with “Node.js” (appears three times) for brand correctness.
markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (1)
6-10: Minor style/grammar polish
Sentences 8-10 are long and nested; a quick pass with shorter sentences will improve readability, especially for non-native speakers.No action required if you prefer to keep the conversational tone.
markdown/docs/community/020-governance-and-policies/CHARTER.md (1)
1-1: Unmatched front-matter delimiterA standalone
---at the top is interpreted as YAML front-matter opener by many static-site generators.
Because there is no closing---, the entire charter may be swallowed as front-matter, breaking page rendering.
Confirm whether this is intended as a horizontal rule or front-matter and add the closing delimiter or an empty line accordingly.markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (2)
77-88: Schema-field mismatch:languagesvslanguageThe Bundler example uses
filters.languages, while the earlier spec (and schema) defines the singularlanguage.
Copy-pasting this example will fail schema validation in the weekly tooling workflow.Either change the example to
language:or update the schema & earlier description to acceptlanguages.
63-75: Markdown table is malformed – breaks renderingSeveral rows have an inconsistent number of pipes which triggers MD055/MD056 and renders the table incorrectly.
Example (header row):
| Field Name | Type | Description | Required |Rows below must match the exact pipe count (4 pipes and a trailing
|).
Please normalise every row; otherwise the docs site shows raw pipe characters instead of a table.⛔ Skipped due to learnings
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#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/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
45-55: Verify asset paths – risk of broken images on the websiteImage sources such as
../../assets/meetings/restream1.pngrely on a path two directories up from060-meetings-and-communication/.
That resolves tomarkdown/docs/assets/meetings/…. Confirm theassets/meetingsfolder really lives undermarkdown/docs/(notmarkdown/docs/community/). Broken images hurt the usability of this how-to guide.markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (1)
37-56: Mermaid node labels contain typos.
A["**Community Working Group**"] -- Chair By --> B→ “Chaired By”D["**AsyncAPI Conference's**"]→ remove apostrophe (“Conferences”).These quick text fixes prevent the diagram from showing confusing grammar.
| 🚧 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 front-matter and context
Right now the page renders as raw Markdown without a header, so it won’t appear in navigation and may break style-guide checks. Consider adding front-matter like:
---
title: Where to Contribute
description: Overview of AsyncAPI repositories and areas welcoming new contributors.
weight: 20
draft: true # until content is ready
---
This allows the page to be listed while still signalling “in progress.”
🤖 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 YAML front-matter with title,
description, weight, and draft fields as shown in the comment. This will enable
the page to render properly with a header, appear in navigation, and comply with
style-guide checks while marking it as a draft.
| Maintainers-->>+Contributor: Proposal acceptance and preperation for next release | ||
| Maintainers->>+Community: Request for a release coordinator volunteer |
There was a problem hiding this comment.
Spelling error
Line 65: “preperation” ➜ “preparation”.
🤖 Prompt for AI Agents
In
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md
at line 65, correct the spelling mistake by changing "preperation" to
"preparation" in the phrase "Proposal acceptance and preperation for next
release".
| Please contact us using the [AsyncAPI Discussions boards](https://github.com/cncf/mentoring/discussions). | ||
|
|
||
| We are also available on the [AsyncAPI slack](https://asyncapi.com/slack-invite). Please don't use DMs unless strictly necessary, as doing so can potentially overwhelm project maintainers, and others with similar questions lose the benefit of public discussion. | ||
|
|
There was a problem hiding this comment.
Wrong repository link for discussions
The link labelled “AsyncAPI Discussions boards” actually points to cncf/mentoring.
Confirm whether this is intentional; otherwise update to the AsyncAPI community discussion page to avoid confusing newcomers.
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/README.md around lines 12 to
15, the link labeled "AsyncAPI Discussions boards" incorrectly points to the
cncf/mentoring repository. Verify if this is intentional; if not, update the URL
to point to the official AsyncAPI community discussion page to prevent confusion
for newcomers.
| | Program | Purpose | Details and historical data | | ||
| | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | ||
| | [AsyncAPI Mentorship](https://www.asyncapi.com/) | Mentoring initiative by AsyncAPI | [asyncapi-mentorship](asyncapi-mentorship/README.md) | | ||
| | [Google Summer of Code](https://summerofcode.withgoogle.com/) | Mentoring program for the students | [summerofcode](summerofcode/README.md) | | ||
| | [Google Season of Docs](https://developers.google.com/season-of-docs) | Mentoring initiative for technical writers | [seasonofdocs](seasonofdocs/README.md) | | ||
| | [Winter of Code](https://www.winterofcode.com) | Mentoring initiative aimed to increase participation for the Google Summer of Code program among students | [winterofcode](winterofcode/README.md) | | ||
| | [OpenForce](https://www.openforce.tech/) | The CROSS Research Experiences program provides support for undergraduate and graduate students contributing to CROSS incubator projects. | [openforce](openforce/README.md) | ||
| | [Hacktoberfest](https://hacktoberfest.com/) | The idea of Hacktoberfest is to encourage everyone, especially beginners, to contribute to projects that are dear to their hearts. | [hacktoberfest](hacktoberfest/README.md) | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Table rows are missing trailing pipes and consistent column counts
Several rows (Winter of Code, OpenForce, Hacktoberfest) omit the closing | which breaks Markdown table rendering and triggers MD055/MD056.
Add the missing pipes so every row has four columns (Program | Purpose | Details and historical data |).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/README.md between lines 18 and
26, several table rows for Winter of Code, OpenForce, and Hacktoberfest are
missing the trailing pipe character at the end of the line, causing inconsistent
column counts and breaking the Markdown table rendering. Add a trailing pipe '|'
at the end of each of these rows to ensure every row has the same number of
columns as the header (three columns plus the trailing pipe), fixing the table
formatting and resolving the MD055/MD056 linting issues.
| We had 2 mentors for our 2 projects: improving our IA and re-structuring our Generator Docs. AsyncAPI requested from Google a US $5000 budget for each project. For both projects, the request then totaled a $10,000 budget. | ||
|
|
||
| | **Budget item** | **Total Amount** | | ||
| |------------------------------------------------------------------------------------------------------|------------------| | ||
| | Technical writer updates, reviews, edits, and publishing new documentation for the IA improvements. | $5000 | | ||
| | Technical writer updates, reviews, migration, and publishing improved Generator tool documentation. | $5000 | | ||
| | **TOTAL** | $10,000 | |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Budget table mis-renders
The budget table lacks a blank line before it and each row is missing leading/trailing pipes, so markdownlint flags MD055/MD058.
Re-add the surrounding blank lines and full pipe set to keep site build clean.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
around lines 28 to 34, the budget table is missing a blank line before it and
each row lacks leading and trailing pipes, causing markdownlint errors MD055 and
MD058. To fix this, add a blank line before the table and ensure every row
starts and ends with a pipe character to conform to proper markdown table
syntax.
| 4. GB members will review the request: | ||
| - Check if the vote is needed, | ||
| - What context is missing, | ||
| - Is larger debate with TSC is needed first. | ||
|
|
There was a problem hiding this comment.
Nested list indentation breaks Markdown render
The sub-points under “GB members will review the request” are indented with a single space instead of the required two/three.
Result: GitHub renders them as a single paragraph.
Adjust indentation so each - aligns two spaces under its parent.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
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)
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/voting.md around lines 34
to 38, the nested list items under "GB members will review the request" are
indented with only one space, causing rendering issues on GitHub. Fix this by
increasing the indentation of each sub-point to two spaces so they properly nest
under the parent list item and render as a list.
| ## Introduction | ||
| Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant community and ignite a passion for event-driven architecture and asynchronous APIs through AsyncAPI adoption. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture. All are powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment. | ||
|
|
||
| Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant developer community and ignite a passion for event-driven architecture and asynchronous APIs. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture. All are powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment. | ||
|
|
There was a problem hiding this comment.
Duplicate paragraph – likely an accidental paste
Lines 12-15 and 15-16 repeat the same “Welcome to our journey…” intro.
Remove one copy to keep the doc concise.
🤖 Prompt for AI Agents
In
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
around lines 12 to 16, there is a duplicated paragraph repeating the same
introduction. Remove one of the duplicate paragraphs to keep the document
concise and avoid redundancy.
| | **Aim** | **Solution** |**Description** | **Tactics** | | ||
| |---------------------------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Goal 1: Encourage Adoption of AsyncAPI and EDA**| |Inspire and motivate contributors worldwide to explore and utilize AsyncAPI specifications and event-driven architectures. | Host and Promote Webinars and Workshops: Organize regular online sessions featuring experts who break down AsyncAPI concepts, with strategic promotion through social media and email campaigns.<br> -Social Media Challenges & Engagement: Launch interactive challenges to encourage developers to share their learnings and projects on social media. <br> - Promoting the current docs we have and utilizing our mentor/maintainership program | | ||
| | |**Expand Community Documentation** | Enhance and expand the existing documentation to make it more comprehensive, accessible for contributors of all levels. | - Multilingual Support: Translate key documentation into multiple languages to make it accessible to a global audience. At least have one translation by the 2nd quarter of the year. <br> - User-Friendly Format: Ensure documentation is well-organized, searchable, and easy to navigate. | | ||
| | |**Utilize Community Initiatives and Mentorship Programs** | Enhance programs that encourage collaboration and mentorship within the community, supporting both new and experienced contributors. | - Thematic Initiatives: Launch initiatives focusing on specific themes like security, performance, or new features. <br> - Support Groups: Promoting the existing working groups for ongoing projects and initiatives. | | ||
| | |**Increase Awareness and Engagement for Community Maintainers** | Develop a marketing-driven approach to attract and promote new maintainers, ensuring the visibility and growth of the AsyncAPI community. (Supporting the community effort) | - Maintainership Storytelling Campaign: Highlight the journey of maintainers through engaging content such as Twitter threads, LinkedIn posts, and video interviews to inspire contributors. <br> - Newsletter Features & Email Marketing: Dedicate a section in AsyncAPI’s newsletter to spotlight maintainers, share open maintainership opportunities, and provide valuable insights for potential contributors. <br> - Recognition and Rewards: Acknowledge and reward maintainers for their contributions to motivate ongoing participation. | | ||
| | | **Promote the Ambassadors Program** | Drive awareness and participation in the Ambassador Program to expand community engagement and advocacy. (Supporting community growth and outreach) | - Program Awareness Campaigns: Leverage social media, blog posts, and community events to highlight the benefits of becoming an AsyncAPI Ambassador. <br> - Onboarding & Training: Provide structured onboarding sessions and resources to equip new Ambassadors for success. Especially the student ambassadors. <br> - Promote the Ambassador Programs: Create a dedicated page on the AsyncAPI website with clear: Program benefits, how to apply (step-by-step process), success stories of existing ambassadors. <br> - Recognition: Acknowledge and reward Ambassadors for their contributions through public recognition. | | ||
| | **Goal 2: Showcase Exceptional Talent** | | Highlight the innovative projects and skills of contributors who are leveraging AsyncAPI and EDA to solve complex challenges. Additionally, showcasing the AsyncAPI end-users representatives and their involvement with the AsyncAPI. Including their exceptional work in the community. | - Feature Success Stories: Publish blog posts and case studies highlighting innovative projects by community members and end-user representatives. <br> - Contributor Spotlights: Regularly feature profiles and interviews of talented contributors in blogs and on social media. <br> - Awards and Recognition: Create a recognition program to reward significant contributions and innovative use cases of AsyncAPI. | | ||
| | | **Empower the Community** | Create opportunities for contributors to enhance their skills, collaborate, and gain recognition for their contributions. | - Create Learning Resources: Develop a comprehensive resource hub with articles, e-books, and video content for skill enhancement. <br> - Facilitate Networking: Host virtual meetups and forums where contributors can connect and collaborate. <br> - Open Source Contributions: Encourage contributions to AsyncAPI projects by providing clear contribution guidelines and mentorship. | | ||
| | **Goal 3:Drive Community Engagement** | | Promote a collaborative and inclusive environment that encourages active participation, knowledge sharing, and continuous learning among community members. | - Interactive Platforms: Maintain active presence on the existing community platforms like Slack, GitHub, LinkedIn, Mastadon, YouTube, and Twitter to facilitate discussions. <br> - Regular Updates: Send out monthly newsletters and blogs with updates, tips, and highlights to keep the community informed and engaged. <br> - Feedback Loops: Implement regular surveys and feedback sessions to understand community needs and improve engagement strategies. | | ||
| | |**AsyncAPI Conference** | Collaborate with the conference coordination WG to organize a series of conferences around the world to promote AsyncAPI, share knowledge, and engage with the global community. | - Event Planning: Plan and schedule events in major countries around the world. <br> - Local Partnerships: Collaborate with local tech communities and organizations to host events. <br> - Speaker Lineup: Invite industry experts and community leaders to speak and share their knowledge. | | ||
| | | **Promote Video Tutorials** | Work with the community working group to create and promote high-quality video tutorials to help community members use and contribute to AsyncAPI projects and understand the EDA concepts effectively. | - Content Development: Work with experts in the community to create high-quality, in-depth video tutorials. This could be inform of the Bounty Program. <br> - Online Learning Platforms: Distribute the videos on our YouTube and other platforms. | | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Tables have missing cells/pipes → broken layout
Rows where the Aim column spans multiple lines leave the second column blank, causing MD055/MD056 violations and misaligned rendering.
Consider:
- Using
<br>tags inside cells instead of leaving a column empty. - Ensuring every row has the same number of
|delimiters.
Without this, GitHub renders the table unpredictably.
🧰 Tools
🪛 LanguageTool
[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)
🤖 Prompt for AI Agents
In
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
around lines 42 to 54, the markdown table has rows with missing cells or empty
columns, causing broken layout and MD055/MD056 lint violations. To fix this,
ensure every row has the same number of pipe delimiters by filling empty cells
with appropriate content or using <br> tags inside cells instead of leaving
columns blank. This will align the table properly and prevent rendering issues
on GitHub.
| - [Acknowledgement of Receipt](#acknowledgement-of-receipt) | ||
| - [Confirmation and Jurisdiction](#confirmation-and-jurisdiction) | ||
| - [Who will have access to reports](#who-will-have-access-to-reports) | ||
| - [Investigation](#investigation) | ||
| - [Notification to the Accused Person](#notification-to-the-accused-person) |
There was a problem hiding this comment.
Bullet indentation uses hard tabs and mixed levels
Lines 12-16 mix hard tabs and inconsistent leading spaces, tripping MD005/MD007. On GitHub the list collapses into plain text.
Convert to spaces and keep a consistent two-space indent per level.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
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)
🤖 Prompt for AI Agents
In markdown/docs/community/COC-incident-resolution-procedures.md around lines 12
to 16, the bullet list uses a mix of hard tabs and inconsistent spaces causing
markdown rendering issues. Replace all hard tabs with spaces and ensure each
nested bullet is indented consistently using two spaces per level to fix the
formatting and restore proper list rendering on GitHub.
| You must start with YouTube first, even though Restream can directly stream there. It is because by | ||
|
|
||
| This is what you need to do to kick it off: |
There was a problem hiding this comment.
Sentence abruptly ends – readers lose the key instruction
It is because by trails off without finishing the thought, leaving the paragraph incomplete. Please complete or remove the sentence so contributors understand why YouTube must be started first in a Restream-first flow.
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 78 to 80, the sentence ending with "It is because by" is incomplete
and leaves the explanation unfinished. Either complete the sentence to clearly
explain why YouTube must be started first before Restream in the streaming flow
or remove the fragment entirely to avoid confusion for readers.
akshatnema
deleted the
update-community-docs-7079b2e04aeef4b28ef01c67d8507eb3bac2c6ab
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation