docs(community): update latest community documentation #4268
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
sambhavgupta0705 and
thulieblack
as code owners
❌ Deploy Preview for asyncapi-website failed.
|
|
Caution Review failedThe pull request is closed. WalkthroughThis update introduces a comprehensive overhaul and expansion of AsyncAPI's community documentation. It adds new structured sections covering onboarding, contribution guidelines, style guide, governance, project vision, guides, mentorship, meetings, and marketing. Numerous new markdown documents, guides, procedural documents, and configuration updates are included, with some obsolete section files removed. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant DocsWebsite
participant GitHub
participant Maintainers
Contributor->>DocsWebsite: Access onboarding/contribution/governance/mentorship/marketing docs
Contributor->>GitHub: Follow guides to submit PRs, join programs, or participate in meetings
DocsWebsite->>Contributor: Provide structured guides, checklists, and program info
Maintainers->>DocsWebsite: Update docs, approve PRs, maintain governance/mentorship/marketing sections
GitHub->>Contributor: Notify on PR status, program participation, or meeting invites
Estimated code review effort4 (~90 minutes) Possibly related PRs
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
asyncapi-bot
requested review from
CBID2,
bandantonio,
devilkiller-ag and
vishvamsinh28
|
cc @bandantonio |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 31
🔭 Outside diff range comments (5)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (1)
11-34: Broken table formatting – fails rendering & markdownlintAll table rows are missing leading/trailing pipes and are not surrounded by blank lines, triggering MD055/MD056/MD058 and causing most renderers to fall back to plain text. Readers will see a long, unreadable paragraph instead of a table.
Example fix for the header (apply the same pattern to every row):
-Number | Idea | Area | Lead Mentor | Scope -:---:|---|:---:|:---:|--- +| No | Idea | Area | Lead Mentor | Scope | +| :-: | --- | :-: | :-: | --- |Add a blank line before and after the table.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md (1)
16-29: Table formatting issues identical to project-ideas.mdMissing pipes and blank-line padding break rendering and violate MD055/MD056/MD058.
Header fix example:
-| No | Project Idea | Mentor/s | Category | Mentee/s | -| --- | --- | --- | --- | --- | +| No | Project Idea | Mentor/s | Category | Mentee/s | +| :-: | --- | --- | :-: | --- |Apply to every row and surround the table with blank lines.
markdown/docs/community/050-mentorship-program/README.md (1)
34-46: Statistics table is malformed – uneven columns & missing pipes.Several rows (e.g., 39, 45) have only three pipes instead of four. This causes mis-alignment and may hide data in some viewers.
Recommend normalising the table to exactly four columns (Year | Program | Participants | Total (per year)), adding empty cells where needed.markdown/docs/community/styleguide/localization.md (1)
80-89: Field name inconsistency with earlier specThe sample Bundler YAML uses
languages:(plural) whereas the table above specifiesfilters.language(singular). Mismatch will break the JSON schema and the weekly automation. Align the example with the official key or call out plural as an accepted alias.markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (1)
249-259: Fix heading-level violation & convert plain URLs into list itemsThe
#####headings under “## Sources” skip two levels (MD001) and render as super-fluous sub-sections instead of a simple reference list.
Switch to a bullet list with angle-bracket or Markdown links to keep the outline clean and avoid broken ToC entries.-## Sources - -##### https://github.com/orgs/asyncapi/discussions/541#discussioncomment-5462792 -##### https://github.com/orgs/asyncapi/discussions/877#discussioncomment-6970799 -##### https://docs.opencollective.com/help/expenses-and-getting-paid/tax-information -##### https://asyncapi.slack.com/archives/C05UHTSEHE2/p1699433566459269 -##### https://github.com/asyncapi/community/pull/897#discussion_r1390778779 -##### https://github.com/asyncapi/community/issues/1072 +## Sources + +* <https://github.com/orgs/asyncapi/discussions/541#discussioncomment-5462792> +* <https://github.com/orgs/asyncapi/discussions/877#discussioncomment-6970799> +* <https://docs.opencollective.com/help/expenses-and-getting-paid/tax-information> +* <https://asyncapi.slack.com/archives/C05UHTSEHE2/p1699433566459269> +* <https://github.com/asyncapi/community/pull/897#discussion_r1390778779> +* <https://github.com/asyncapi/community/issues/1072>
♻️ Duplicate comments (3)
markdown/docs/community/000-onboarding/how-to-contribute.md (1)
6-8: Deduplicate placeholder boilerplateRecommend using the central WIP shortcode/component instead of hard-coding the placeholder message here as well.
markdown/docs/community/000-onboarding/where-to-contribute.md (1)
6-8: Use shared WIP componentSame remark as above about extracting the placeholder into a shared component.
markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md (1)
6-8: Placeholder standardisationReuse the common WIP component instead of repeating raw text.
🧹 Nitpick comments (92)
markdown/docs/community/010-contribution-guidelines/create-new-docs-directories.md (1)
6-6: Heading level seems offBecause the page title will already be rendered from front-matter as an H1, starting the body with
### Create new docs directoriesskips the H2 level and duplicates the wording. Consider dropping the in-body heading or using##if you need a second-level section.markdown/docs/community/070-marketing/social-media-communication-guidelines.md (2)
1-4: Consider marking the page as draft until content is readyRight now the front-matter publishes an empty placeholder page. To avoid exposing incomplete docs in production, add
draft: true(or the project-specific equivalent) to the front-matter until the guidelines are written.
6-8: Replace plain placeholder text with a reusable “Work-in-progress” componentSeveral new docs repeat the same “🚧 This document is under construction” lines. Extract this into a reusable shortcode/component (e.g.
{{< wip >}}) so future placeholders are consistent and easier to update globally.markdown/docs/community/000-onboarding/how-to-contribute.md (1)
1-4: Hide unfinished page from navigationSame as previous file: consider adding
draft: true(or the site’s hidden flag) to prevent half-done content from showing up in the sidebar or search index.markdown/docs/community/000-onboarding/where-to-contribute.md (1)
1-4: Weight collision risk
weight: 10is the same as other pages in this section; depending on the site generator this might lead to nondeterministic ordering. Assign unique weights (e.g. 10, 20, 30…) or rely on alphabetical ordering by omitting weight.markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md (1)
1-4: Front-matter completenessConsider adding a short
description:field—this improves SEO and link previews once the page is published.markdown/docs/community/community-glossary.md (1)
1-3: Glossary placeholder should reference style-guide glossarySince there is already a glossary under
011-styleguide/glossary.md, add a note or link here to avoid confusion and potential duplication once both pages are filled out.markdown/docs/community/010-contribution-guidelines/tools-and-setup.md (1)
2-3: Weight change: double-check orderingWeight was dropped from 60 → 30. Ensure surrounding docs have complementary weights so this guide still appears in the intended position.
markdown/docs/community/000-onboarding/ambassador-guide.md (1)
3-3: Weight adjustment: confirm intentChanging the weight from 110 → 50 will push this guide much higher in the onboarding menu. Make sure that’s the desired UX.
markdown/docs/community/010-contribution-guidelines/conventional-commits.md (1)
4-4: Weight updateWeight lowered to 60; fine as long as sidebar order still logical.
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
47-47: Minor style nit: heading capitalisation
Sentence case (“Let’s build something amazing together”) is preferred for consistency with earlier headings.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)
6-14: Blank lines required before and after the table
markdownlintflags MD058: add an empty line above the header row and below the final row to satisfy “blanks-around-tables”. This prevents rendering quirks and keeps linter green.markdown/docs/community/050-mentorship-program/index.md (1)
6-14: Fix introductory sentence grammar and tighten wordingThe opening sentence reads a bit awkwardly (“...within the AsyncAPI Initiative to participation…”).
A small tweak improves readability:-This section serves as your gateway to all mentorship opportunities within the AsyncAPI Initiative to participation in major open-source programs. +This section serves as your gateway to mentorship opportunities within the AsyncAPI Initiative and participation in major open-source programs.No other structural issues spotted.
config/edit-page-config.json (1)
29-65: Consider grouping new community/ paths for faster lookup**All newly-appended community paths come after an unrelated “styleguide” entry.
Keeping related entries together (or alphabetically sorted) helps future maintainers scan this file quickly.
No functional problem, but re-ordering would improve readability.markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
27-37: Minor punctuation/whitespace issues in numbered list
- Extra space before the bullet in item 6 (
- Follow)- Stray space + period after the 🙏🏼 emoji in item 10.
Consider cleaning these up to avoid markdown-lint warnings.
markdown/docs/community/010-contribution-guidelines/index.md (1)
6-26: Consider adding quick-links to the detailed sub-guides
Readers landing on this overview still need to dig through the left-hand nav to reach the actual guides. A short “In this section:” list with relative links to the individual markdown files (e.g.git-workflow.md,conventional-commits.md) would make navigation snappier and reduce bounce.markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
34-37: Provide meaningful alt-text for the screenshot
will be flagged by accessibility auditors. Add a short description such as “Screenshot of the GitHub ‘Global workflow to rule them all’ manual trigger button”.markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
16-44: Replace bold emphasis with proper headings (MD036 violation)
Static analysis (MD036) flags the use of**Step X …**as headings. Converting them to H3s keeps styling consistent and improves anchor links.-**Step 1: Pick an Issue** +### Step 1: Pick an Issue ... -**Step 2: Open a Pull Request** +### Step 2: Open a Pull Request ... -**Step 3: Get Pull Request Merged** +### Step 3: Get Pull Request Merged ... -**Step 4: Invitation to Become a Maintainer** +### Step 4: Invitation to Become a Maintainer ... -**Step 5: Become a TSC Member** +### Step 5: Become a TSC Membermarkdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (1)
30-33: Indentation inside list items violates MD007The four bullet lines after the table are indented with two spaces. Remove the extra indentation or make them part of a parent list.
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (1)
16-21: Very long bullet – consider splitting for readabilityThe first bullet spans three sentences; consider breaking it into sub-bullets or separate sentences.
markdown/docs/community/000-onboarding/upholding-code-of-conduct.md (1)
27-32: Minor style: capitalize “Community-oriented” consistentlyBullet 3 starts with lowercase “community-oriented”. Capitalize for parallelism with the other bullets.
markdown/docs/community/020-governance-and-policies/index.md (1)
8-13: Add deep-links to referenced governance artifactsEach bullet introduces a specific resource (Charter, TSC voting, RFC process, etc.) yet none of them are hyper-linked. Readers landing on this overview will have to hunt manually. Consider linking to the exact Markdown files you added in the same folder (e.g.
CHARTER.md,TSC_VOTING_OVERVIEW.md,introduction-of-changes-to-spec.md, etc.) so navigation is one-click.Also applies to: 14-19, 20-25, 26-31, 32-35
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (2)
12-19: Tighten wording & fix minor grammarThe paragraph mixes pronouns and has a run-on sentence (“You come up with the idea that we used to do something great with the project”). Suggest trimming for clarity.
47-49: Use consistent list markerLines 48-49 use
*while the rest of the file (and AsyncAPI docs in general) use-. Harmonise the bullet style.markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (2)
26-30: Hard tabs + en-dashTab characters slipped in lines 27 & 29; replace with spaces.
Also, replace the hyphen in “September - October” with an en-dash (“September–October”) for typographic correctness.
46-46: Convert bare URL to markdown linkLine 46 is flagged by MD034. Wrap the URL in
[text](url)to keep renderers and link-checker happy.markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (2)
8-9: Redundant wording“…crafting impressive proposals that will impress us…” repeats “impress”. A simple “…crafting strong proposals that stand out.” reads better.
17-18: Minor formatting“Contact Number(include your country code)” → “Contact number (include country code)” for casing consistency and missing space.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)
14-14: Minor markdown escape not needed.The back-slashed parentheses in
Mentorship duration - seven months \(full-time schedule\)
display literally. Remove the escapes unless the backslash is intentional.markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (2)
5-5: Grammar fix: missing comma after “responds to”.Current sentence: “responds to investigates, and resolves …”.
Suggested: “responds to, investigates, and resolves …”.
28-28: Long paragraph hurts readability; consider bullet-pointing key rules.The decision-making paragraph spans >400 chars without a break, making it hard to scan. Splitting into bullet points or sub-paragraphs improves accessibility and localisation.
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (2)
6-7: “GitHub user name” → “GitHub username”.Minor wording nit – compound noun is commonly one word.
6-6: File is auto-generated – highlight update script path.The comment says “point to the script”; providing its relative path here would help contributors locate and debug the generator quickly.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (2)
13-17: Numbered list renders as “1.” three times – pick either auto-increment or explicit numberingMarkdown will render fine, but it looks sloppy in raw form and tends to trip up copy editors.
Either:
- leave all items as
1.(CommonMark auto-numbering), or- write them as
1.,2.,3.so the source mirrors the output.Pick one style and keep it consistent across guidelines.
22-26: Indentation + bare URL break markdown-lint rulesThe sub-bullets under “Place all images …” are indented by three spaces instead of two and the direct URL triggers MD034. Consider:
- - Compress the image as much as possible; we recommend using the following tool: https://squoosh.app. - - The output format needs to be `.webp`. - - Include detailed `alt` descriptions for screenreader users. + - Compress the image as much as possible; we recommend <https://squoosh.app>. + - The output format must be `.webp`. + - Include detailed **alt** text for screen-reader users.This fixes MD007 (ul-indent) and MD034 (no-bare-urls).
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (3)
58-59: Tighten wording around Code of Conduct reference“Always behave with respect to AsyncAPI Code of Conduct”
Consider “Always comply with the AsyncAPI Code of Conduct” – clearer and avoids wordiness flagged by LanguageTool.
76-80: Mixed bullet markers inside the same list
*is used for the parent list, but the inner items switch to-, triggering MD004.
Use*consistently:-* Slack: - - `#95_bot-tsc-members-mentioned` – … - - `TSC Voting Reminder`: … -* Email: … -* GitHub Notifications: … +* Slack: + * `#95_bot-tsc-members-mentioned` – … + * `TSC Voting Reminder` – … +* Email: … +* GitHub Notifications: …
88-88: Bare URL in bullet listSurround the link with
<>or[label](url)to satisfy MD034:- * TSC members are promoted at https://www.asyncapi.com/community/tsc + * TSC members are promoted at <https://www.asyncapi.com/community/tsc>markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (2)
6-6: Trailing slash in invite link differs from existing docsMost AsyncAPI docs use
https://www.asyncapi.com/slack-invite(no trailing slash).
Staying consistent avoids duplicate analytics entries.
32-33: Back-tick explanation renders oddly
Use backticks (``) for coderenders as an empty inline code block. Use escaped single back-ticks or wrap the word backticks in italics:-* **Use formatting to improve readability:** … Use backticks (``) for code, bold … +* **Use formatting to improve readability:** … Use back-ticks (`) for inline code, bold …markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
17-18: Typo: “Specifing” → “Specifying”- - **Specifing dynamic parts of channel name** - Explain how to use and reuse parameters. + - **Specifying dynamic parts of channel name** – Explain how to use and reuse parameters.
26-29: Minor wording & consistencyA few quick wins:
- “are common only for a given protocol”
- “Adding server security” (singular) to parallel previous bullet wording.
- Remove double space in “create a learning experience”.
No functional change, purely polish.
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (3)
7-8: Spelling + bare URL
- “annoucement” → “announcement”
- Wrap the URL in angle brackets to silence MD034.
- > Program participation annoucement can be found here https://github.com/orgs/asyncapi/discussions/556 + > Program participation announcement can be found here <https://github.com/orgs/asyncapi/discussions/556>
16-18: Ordinal suffixes: “23th” → “23rd”- - Project publication and Student registration starts: 23th January + - Project publication and student registration starts: 23rd January
30-37: Markdown table missing trailing pipes → breaks some renderersFor maximum compatibility (and to satisfy MD055) add a trailing pipe on each row:
-Number | Project/Issue | Area | Mentor | ----|---|---|--- +| Number | Project/Issue | Area | Mentor | +| --- | --- | --- | --- |…and so on for each data row.
markdown/docs/community/011-styleguide/styling.md (1)
48-55: Minor grammar & casing nits in “CSS Statements / Naming Convention” section
- “rulesets(already defined above)” → missing space after “rulesets”.
- “css code” should be “CSS code” for consistency with the rest of the doc.
Tweak wording to tighten the prose when you next touch the file.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (2)
6-10: Heading level skips from H1 → H3
### Ideas listshould be## Ideas listto preserve sequential heading increments (MD001).
This improves navigation and screen-reader outlines.
26-28: HTML<br>tags inside Markdown table
</br>is present inside the “Why should it be picked?” column.
Using literal<br>inside tables renders inconsistently across engines—prefer plain text with semicolons or multiple sentences instead.markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (1)
60-66: Typo & phrasing in automation description
- “checkes if voters file was edited” → “checks whether a VOTERS file was edited”.
- Consider rephrasing long bullet to shorter sentences for clarity.
Minor but this README will be referenced by applicants; polishing increases credibility.
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (1)
58-66: Currency duplication“$350 dollars” repeats the currency symbol; “$350” or “350 dollars” suffices.
Tiny detail, but worth updating before publication.markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (3)
22-26: Standardise technology names and capitalisation
Javascript/TypescriptandOpen Source Contributionare inconsistent with elsewhere (JavaScript/TypeScript,open-source contribution). Please keep technology names and compound adjectives consistently capitalised and, where appropriate, hyphenated (e.g. open-source).
49-52: Use sentence-case and correct branding for “GitHub Actions” & “Node.js”Lines 67–68, 76 present “Github actions”/“Node js”. Prefer the correct brand names: GitHub Actions and Node.js.
79-88: Align unit label capitalisationProject 8 uses “175 hours” (lower-case h). Earlier items use “Hours”. Pick one style and apply uniformly.
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (2)
28-38: Add blank lines before and after the tableMarkdown-lint flags
MD058because the table isn’t wrapped by blank lines.
Insert one empty line above line 30 and one below line 38 to improve rendering and satisfy tooling.
10-26: Check date formatting consistencyDates mix “April 02” and “May 1”. Consider a consistent day-padding style (either
May 01orApril 2) across the timeline.markdown/docs/community/010-contribution-guidelines/git-workflow.md (2)
74-80: Typo in upstream URL placeholderExample shows
https://github.com/asyncapi/community.git; earlier you clonedasyncapi-community. Use one canonical repo name (likelycommunity). Mixing names can mislead newcomers.
121-123: Link to Conventional Commits spec instead of PRThe current link points to a closed PR; redirect to the official Conventional Commits page (
https://www.conventionalcommits.org/) for longevity.markdown/docs/community/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md (2)
60-67: Avoid bare API URL inside documentation
https://api.github.com/users/…is flagged byMD034. Wrap it in angle brackets (<https://…>) or backticks to satisfy linters and improve readability.
46-48: Minor style improvement“Be in tune with AsyncAPI's mission” reads wordy; consider “Align with AsyncAPI's mission” to tighten language, but feel free to keep if intentional.
markdown/docs/community/050-mentorship-program/summerofcode/README.md (2)
15-20: Use plural “Requirements” and tighten eligibility wordingThe section title is singular (“Requirement”) while you list multiple criteria below.
Consider renaming the heading to “Requirements” and, for clarity, merge the age & “new to open-source” points into a concise bullet list.
This keeps structure consistent with the rest of the document and avoids readers thinking there is only one requirement.
23-24: Clarify non-coding alternatives“GSoD” is introduced without expansion. Spell it out (Google Season of Docs) the first time to avoid confusion for newcomers unfamiliar with the acronym.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (1)
98-103: Long sentences reduce clarity in ‘Acceptance’The first bullet runs >45 words and mixes three decisions (mentor review, multiple mentors, contributor choice).
Split into distinct sentences or sub-bullets so applicants can scan requirements quickly.markdown/docs/community/020-governance-and-policies/voting.md (1)
40-43: Indentation inside numbered list breaks MD formattingLines beginning “Check if…”, “What context…”, “Is larger debate…” are indented with a single space, which markdownlint flags (MD007).
Either remove the space or indent four spaces so they render as sub-bullets of point 4.markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (2)
26-33: Subject–verb agreement“The contributors/maintainers reviews” → “The contributors/maintainers review”.
Minor grammar fix keeps the process description professional.
51-54: Phrase “world of open source won again” is informalDocs across governance folder use a formal tone. Consider replacing with something neutral like “the release is announced publicly”.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (2)
35-39: Images missing alt textBoth donation button images lack
altattributes, flagged by MD045. Add short descriptive alt text (e.g., “Donate via Open Collective”).
111-114: Formal tone & mailto linkThe paragraph starts with “Feel free to contact us…”. Replace with a more objective invitation (“For further information, contact us at [email protected]”).
Also turn the bare email into amailto:link to satisfy MD034.markdown/docs/community/styleguide/localization.md (3)
38-41: Minor phrasing / grammar issue“In Structural Considerations” the sentence starts “Avoid region-specific formats and always specify time zones… For example, of writing …” → should read “instead of writing”.
42-48: Currency example repeats information and could cause confusionLines 44-48 restate the same guidance twice (currency code & symbol usage). Consider compressing into a single bullet to keep the list concise.
126-127: Spelling: “Moreoever” → “Moreover”Tiny typo caught by LanguageTool.
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (2)
69-75: Clarify optional vs required flagsThe description column marks
links.repoUrlas “optional”, but earlier you call it the default when omitted. That can confuse contributors—spell out the exact fallback behaviour.
73-75: Link totags-color.tspoints to color file, not canonical language list
tags-color.tscurrently stores only colour mapping, not the authoritative language list. Suggest pointing tofilters-schema.json(or equivalent) where allowed enum values live.markdown/docs/community/070-marketing/webinar_series_initiative.md (1)
43-50: Heading punctuation violates markdown-lint ruleLine 146 “## Disclaimer:” ends with a colon; MD026 flags this. Drop the trailing punctuation to stay lint-clean.
markdown/docs/community/011-styleguide/version-control.md (2)
57-60: Extra space in heading“### When Submitting Changes” has a double space after “Submitting”.
90-95: Superfluous double spaceLine 94 contains two spaces before “in existing documentation”. Clean up to keep formatting tidy.
markdown/docs/community/020-governance-and-policies/donating-projects.md (1)
22-25: Smooth out repetitive bullet startsThree consecutive bullets start with “We …” which reads monotonously.
Consider varying the opening verbs (e.g., “Value Contributor License Agreements …”, “Require an IP review …”).markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
48-48: Remove extra spaces inside link text
[asyncapi/cli ]contains trailing spaces, breaking MD039.-[asyncapi/cli ](https://github.com/asyncapi/cli) +[asyncapi/cli](https://github.com/asyncapi/cli)markdown/docs/community/000-onboarding/github-actions.md (3)
58-60: Consistent bullet styleThe list under “explore it” switches from
-to*, triggering MD004.
Use a single marker for the whole document.-* When the workflow is triggered … -* What problem it solves … -* Any conditions or repository limitations. +- When the workflow is triggered … +- What problem it solves … +- Any conditions or repository limitations.
70-72: Bullet marker inconsistency (replicator list)Same issue as above; replace
*with-for consistency.
95-103: Use headings instead of bold for “Opt-in/Opt-out”Bold text is flagged by MD036. Convert to proper headings:
-**Opt-in** +#### Opt-in … -**Opt-out** +#### Opt-outmarkdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (2)
86-88: Fix unordered-list indentationList under “Blog and Community Newsletter Communication” is indented with four spaces, triggering MD007 and rendering oddly. Dedent to two spaces.
137-137: Remove trailing colon in heading“### Social Media Cross-Promotion:” ends with a colon, violating MD026.
markdown/docs/community/020-governance-and-policies/GOVERNANCE.md (2)
84-100: Heading-level jumps break navigation and violate MD001
#### Fran Mendez(H4) is directly followed by### Lukasz Gornicki(H3).
Incrementing heading levels by more than one step confuses screen readers and anchors.Consider normalising both to
###(or nest both under an H3 wrapper such as “Past Directors”) to keep a consistent hierarchy.
41-44: Streamline wording for clarityPhrase “In the event that a board member's term is terminated prior to its scheduled end” is verbose.
A concise alternative: “If a board member’s term ends early, a replacement election must be held within 60 days.”Similar phrasing occurs earlier (“60 days prior to elections”). Tightening wording improves readability without changing meaning.
markdown/docs/community/COC-incident-resolution-procedures.md (1)
97-99: Sentence length & passive voice hinder comprehensionThe notification paragraph is a single 80-word sentence with multiple subordinate clauses. Breaking it into 2-3 sentences and reducing passive voice (“shall notify…”, “shall determine…”) will make responsibilities clearer to readers skimming for process steps.
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (1)
12-14: Minor wording tweak for conciseness“work in a transparent manner” → “work transparently”
One word keeps the same meaning and tightens the sentence.markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (1)
70-77: External links lack descriptive textThe list mixes bare URLs and descriptive links. For accessibility, wrap each program name in a Markdown link and move raw URLs to the href:
[AsyncAPI Bounty Program](https://www.asyncapi.com/blog/asyncapi-bounty-program-2024)Consistent, descriptive links improve screen-reader output and satisfy MD034.
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
21-23: Mixed list markers trigger MD004The first bullet list uses
*while the remainder of the doc uses-.
Pick one style (project default seems to be-) to avoid lint noise and keep diffs clean.markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (4)
30-33: Clarify the “maximum quantity” sentenceThe parenthetical math (
((12 * 400) + (1 * 200))) is hard to parse, and readers have to compute the totals themselves.
Recommend providing the final numbers directly:-The approximate maximum quantity of Bounty Issues per calendar quarter round varies from thirteen to twenty-five (from ((12 * 400) + (1 * 200)) to (25 * 200)). +The quarterly budget allows roughly 13 to 25 bounty issues (e.g. twelve × $400 + one × $200 up to twenty-five × $200).
78-86: Reduce repetitive “In case …” openersFour consecutive sentences start with “In case”, triggering readability lint and making the section monotonous.
Consider restructuring with bullets or combining related conditions to vary sentence openings.
97-99: Convert bare URL to proper Markdown linkBare URLs break some linters (MD034) and impair accessibility. Wrap the project view link:
-GitHub issues selected as Bounty Issues can be viewed with GitHub's Project View tool at https://github.com/orgs/asyncapi/projects/36 +GitHub issues selected as Bounty Issues can be viewed with GitHub’s Project View tool at <https://github.com/orgs/asyncapi/projects/36>
120-136: Minor wording clean-ups
- “activity of the automated code analysis service that runs on every commit (
SonarCloud)" → replace “activity of” with “from”.- “prior to” → “before”.
- “abovementioned” → “above-mentioned” or omit.
These tweaks silence LanguageTool flags and improve flow.
No functional impact—purely editorial.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (103)
config/edit-page-config.json(1 hunks)markdown/docs/community/000-onboarding/_section.md(1 hunks)markdown/docs/community/000-onboarding/ambassador-guide.md(2 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/github-actions.md(1 hunks)markdown/docs/community/000-onboarding/how-to-contribute.md(1 hunks)markdown/docs/community/000-onboarding/index.md(1 hunks)markdown/docs/community/000-onboarding/maintainer-guide.md(2 hunks)markdown/docs/community/000-onboarding/upholding-code-of-conduct.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/_section.md(1 hunks)markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md(3 hunks)markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribute-to-docs.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribution-flow.md(3 hunks)markdown/docs/community/010-contribution-guidelines/conventional-commits.md(2 hunks)markdown/docs/community/010-contribution-guidelines/create-new-docs-directories.md(1 hunks)markdown/docs/community/010-contribution-guidelines/git-workflow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md(1 hunks)markdown/docs/community/010-contribution-guidelines/index.md(1 hunks)markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md(2 hunks)markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.md(1 hunks)markdown/docs/community/010-contribution-guidelines/prerequisite-knowledge.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognize-contributors.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md(1 hunks)markdown/docs/community/010-contribution-guidelines/technical-writer-contributor-responsibilities.md(1 hunks)markdown/docs/community/010-contribution-guidelines/tools-and-setup.md(2 hunks)markdown/docs/community/011-styleguide/_section.md(1 hunks)markdown/docs/community/011-styleguide/content-buckets.md(1 hunks)markdown/docs/community/011-styleguide/formatting.md(1 hunks)markdown/docs/community/011-styleguide/glossary.md(1 hunks)markdown/docs/community/011-styleguide/grammar.md(2 hunks)markdown/docs/community/011-styleguide/inclusive-language.md(1 hunks)markdown/docs/community/011-styleguide/index.md(1 hunks)markdown/docs/community/011-styleguide/links.md(1 hunks)markdown/docs/community/011-styleguide/numbers.md(2 hunks)markdown/docs/community/011-styleguide/punctuation.md(1 hunks)markdown/docs/community/011-styleguide/seo-guide.md(1 hunks)markdown/docs/community/011-styleguide/styling.md(1 hunks)markdown/docs/community/011-styleguide/version-control.md(1 hunks)markdown/docs/community/011-styleguide/voice-and-tone.md(1 hunks)markdown/docs/community/020-governance-and-policies/CHARTER.md(1 hunks)markdown/docs/community/020-governance-and-policies/GOVERNANCE.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/_section.md(1 hunks)markdown/docs/community/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md(1 hunks)markdown/docs/community/020-governance-and-policies/donating-projects.md(1 hunks)markdown/docs/community/020-governance-and-policies/index.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/030-project-vision-strategy-goals/_section.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/index.md(1 hunks)markdown/docs/community/040-guides/_section.md(1 hunks)markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md(1 hunks)markdown/docs/community/040-guides/index.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/_section.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/index.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/_section.md(1 hunks)markdown/docs/community/060-meetings-and-communication/docs-community.md(1 hunks)markdown/docs/community/060-meetings-and-communication/index.md(1 hunks)markdown/docs/community/060-meetings-and-communication/slack-etiquette.md(1 hunks)markdown/docs/community/070-marketing/_section.md(1 hunks)markdown/docs/community/070-marketing/index.md(1 hunks)markdown/docs/community/070-marketing/social-media-communication-guidelines.md(1 hunks)markdown/docs/community/070-marketing/webinar_planning_template.md(1 hunks)markdown/docs/community/070-marketing/webinar_series_initiative.md(1 hunks)markdown/docs/community/COC-incident-resolution-procedures.md(1 hunks)markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md(1 hunks)markdown/docs/community/community-glossary.md(1 hunks)markdown/docs/community/onboarding-guide/_section.md(0 hunks)markdown/docs/community/styleguide/_section.md(0 hunks)markdown/docs/community/styleguide/localization.md(1 hunks)
🧠 Learnings (36)
📓 Common learnings
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: TRohit20
PR: asyncapi/website#4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: asyncapi/website#4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
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: 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.
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/011-styleguide/links.md (6)
Learnt from: akshatnema
PR: #3262
File: components/Avatar.tsx:35-44
Timestamp: 2024-10-11T10:46:58.882Z
Learning: In Next.js, when avoiding nested <a> tags due to hydration issues, use accessible non-link elements like <button> or <span> with appropriate roles, tabIndex, and event handlers to maintain accessibility and SEO.
Learnt from: akshatnema
PR: #3262
File: components/newsroom/FeaturedBlogPost.tsx:90-92
Timestamp: 2024-10-11T07:38:35.745Z
Learning: In Next.js, nested <a> tags cause hydration issues due to invalid HTML. To fix this, avoid nesting <a> tags by replacing inner <a> tags with non-interactive elements like <span>, and use click handlers to maintain interactivity if needed.
Learnt from: akshatnema
PR: #3262
File: components/navigation/BlogPostItem.tsx:95-119
Timestamp: 2024-10-11T11:32:30.226Z
Learning: In the BlogPostItem component (components/navigation/BlogPostItem.tsx), nesting <a> tags inside the parent Link component leads to hydration issues; therefore, we should avoid nesting <a> tags inside Link components in this component.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: anshgoyalevil
PR: #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: #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/011-styleguide/grammar.md (2)
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: TRohit20
PR: #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/000-onboarding/index.md (4)
Learnt from: iambami
PR: #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: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: #3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the public prefix (e.g., use /img/avatars/... instead of /public/img/avatars/...).
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
markdown/docs/community/060-meetings-and-communication/docs-community.md (1)
Learnt from: iambami
PR: #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.
markdown/docs/community/010-contribution-guidelines/conventional-commits.md (4)
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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: akshatnema
PR: #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/maintainer-guide.md (3)
Learnt from: anshgoyalevil
PR: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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: #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: #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: #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: #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/011-styleguide/index.md (4)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: bandantonio
PR: #3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the public prefix (e.g., use /img/avatars/... instead of /public/img/avatars/...).
Learnt from: TRohit20
PR: #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/000-onboarding/ambassador-guide.md (1)
Learnt from: aminoxix
PR: #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/prerequisite-knowledge.md (1)
Learnt from: TRohit20
PR: #4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
/please-take-a-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/070-marketing/index.md (1)
Learnt from: anshgoyalevil
PR: #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/code-contributor-guide.md (5)
Learnt from: akshatnema
PR: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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: #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.
Learnt from: akshatnema
PR: #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.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
Learnt from: anshgoyalevil
PR: #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/contribution-flow.md (3)
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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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: akshatnema
PR: #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/010-contribution-guidelines/recognize-contributors.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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/040-guides/index.md (1)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (3)
Learnt from: iambami
PR: #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: #4074
File: markdown/blog/open-nest.md:11-12
Timestamp: 2025-04-28T01:13:59.084Z
Learning: For AsyncAPI blog posts, author photo filenames don't necessarily need to match the author's official name, as some authors may use pen names or nicknames (e.g., Aishat Muibudeen using "maya_picture.webp" for her avatar).
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
/please-take-a-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/010-contribution-guidelines/git-workflow.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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (2)
Learnt from: anshgoyalevil
PR: #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: #3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (2)
Learnt from: akshatnema
PR: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
Learnt from: anshgoyalevil
PR: #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: #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: #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/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
Learnt from: aminoxix
PR: #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/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md (1)
Learnt from: aminoxix
PR: #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/styleguide/localization.md (1)
Learnt from: anshgoyalevil
PR: #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.
markdown/docs/community/011-styleguide/styling.md (3)
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: TRohit20
PR: #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: bandantonio
PR: #3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the public prefix (e.g., use /img/avatars/... instead of /public/img/avatars/...).
markdown/docs/community/011-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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/000-onboarding/github-actions.md (5)
Learnt from: akshatnema
PR: #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: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: anshgoyalevil
PR: #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: anshgoyalevil
PR: #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:
echo "key<<EOF" >> "${GITHUB_OUTPUT}"
echo "${value}" >> "${GITHUB_OUTPUT}"
echo "EOF" >> "${GITHUB_OUTPUT}"markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (4)
Learnt from: anshgoyalevil
PR: #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: #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: #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: #3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the tests/fixtures/tools/automated-tools.json file, the language field within the filters object can be either a string or an array. Both formats are acceptable and supported in the codebase.
markdown/docs/community/070-marketing/webinar_series_initiative.md (1)
Learnt from: iambami
PR: #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.
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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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/introduction-of-changes-to-spec.md (2)
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
🪛 LanguageTool
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...google.github.io/gsocguides/mentor/) - [Open Source Best Practices](https://opensource.guid...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
[style] ~14-~14: Consider using a synonym to be more concise.
Context: ...//github.com/AceTheCreator) | There are a lot of places where components need to be crea...
(A_LOT_OF)
[style] ~19-~19: 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] ~32-~32: 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] ~32-~32: 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/010-contribution-guidelines/recognize-contributors.md
[style] ~16-~16: 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] ~20-~20: ‘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] ~22-~22: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... if we failed in recognizing your work. Feel free to contact us on [slack](https://asyncapi....
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
[style] ~18-~18: 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/010-contribution-guidelines/identifying-good-first-issues.md
[style] ~79-~79: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4168 characters long)
Context: ...d let's build something awesome together!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/050-mentorship-program/README.md
[style] ~8-~8: 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/winterofcode/2023/README.md
[grammar] ~7-~7: Ensure spelling is correct
Context: ...us: In Progress > Program participation annoucement can be found here https://github.com/or...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
[style] ~22-~22: Phrases like “ I think we” can make your message sound insecure. Consider making your writing sound more confident and self-assured.
Context: ...hrow exceptions from the main function. I think we should standardize this and propose a system b...
(I_THINK_WE_SHOULD)
[style] ~25-~25: Consider using a synonym to be more concise.
Context: ...y and we use GitHub Actions to automate lots of things in the organization. GitHub acti...
(A_LOT_OF)
[style] ~27-~27: Consider a different adjective to strengthen your wording.
Context: ...ub.com/asyncapi/cli) | @fmvilas | We're doing a great job at Glee and Generator and it's about th...
(DO_A_GREAT_JOB)
[grammar] ~29-~29: Ensure spelling is correct
Context: ...eople and companies doing serverless or Fuction-as-a-Service (FaaS). Making Glee integr...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~30-~30: ‘in difficulty’ might be wordy. Consider a shorter alternative.
Context: ... is probably the most complicated issue in difficulty. If we want people to adopt Glee in pro...
(EN_WORDINESS_PREMIUM_IN_DIFFICULTY)
[grammar] ~30-~30: Ensure spelling is correct
Context: ...dopt Glee in production, it needs to be prodution-ready, and that means being able to han...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md
[uncategorized] ~49-~49: 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)
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md
[style] ~7-~7: 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/050-mentorship-program/seasonofdocs/2023/project-ideas.md
[style] ~28-~28: 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
[grammar] ~18-~18: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~32-~32: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[style] ~58-~58: ‘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] ~63-~63: 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)
markdown/docs/community/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md
[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...come ambassadors for the whole year. 3. If you were accepted as ambassador on the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~46-~46: ‘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] ~61-~61: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...he process of becoming an ambassador is very simple. Go to the community repository and...
(EN_WEAK_ADJECTIVE)
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md
[style] ~12-~12: Consider replacing this phrase with the adverb “transparently” to avoid wordiness.
Context: ...s have a voice and that the group works in a transparent manner. Multiple chairpersons can be elected i...
(IN_A_X_MANNER)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
[grammar] ~79-~79: Ensure spelling is correct
Context: ... In that case, AsyncAPI may require the Progam Administrators to designate a replacement Mentor and r...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~99-~99: Ensure spelling is correct
Context: ...iewed by the selected project Mentor to which they were submitted. A Mentor may accep...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[uncategorized] ~111-~111: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...licly accessible location and under an [Open Source Initiative approved license](http://www...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
[style] ~45-~45: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...e to projects under AsyncAPI Initiative on a regular basis, and we'll welcome them as new maintain...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
[style] ~112-~112: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...r=blue" width=300 /> ### Contact Feel free to contact us if you need more explanation...
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/020-governance-and-policies/donating-projects.md
[style] ~24-~24: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...r both maintainers and contributors. - We make Intellectual Property (IP) Review ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
[uncategorized] ~55-~55: 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)
[style] ~107-~107: This phrase is redundant (‘O’ stands for ‘Optimization’). Use simply “SEO”.
Context: ... | ## Website Traffic Growth ### SEO Optimization - Improve AsyncAPI website SEO with hi...
(ACRONYM_TAUTOLOGY)
markdown/docs/community/011-styleguide/styling.md
[style] ~87-~87: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ions. - Use one declaration per line. - Use a trailing semi-colon ; on the last d...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
[style] ~49-~49: 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] ~49-~49: 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] ~53-~53: Consider using an en dash here instead of a hyphen.
Context: ...t each new TW contributor started. - June - August: Each TW goes through designate...
(QB_NEW_EN_DASH_RULE_EN)
[typographical] ~54-~54: Consider using an en dash here instead of a hyphen.
Context: ... for the issues assigned/selected. - September - October: We determine if we can comple...
(QB_NEW_EN_DASH_RULE_EN)
[style] ~59-~59: 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/seasonofdocs/2022/README.md
[typographical] ~28-~28: Consider using an en dash here instead of a hyphen.
Context: ...or their issues assigned/selected. - September - October: We determined if we could com...
(QB_NEW_EN_DASH_RULE_EN)
markdown/docs/community/COC-incident-resolution-procedures.md
[style] ~97-~97: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ... the nature of the allegations, if any, taking into consideration risks of retaliation, evidence tamperin...
(TAKE_INTO_CONSIDERATION)
[style] ~107-~107: ‘mutual agreement’ might be wordy. Consider a shorter alternative.
Context: ...torative Justice" below), mediation, or mutual agreement, the CoC Committee will wait until the ...
(EN_WORDINESS_PREMIUM_MUTUAL_AGREEMENT)
[style] ~107-~107: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tor may help facilitate the discussion. If the involved parties agree on an outcom...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~191-~191: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ided information, if only one person or a very small number of people were involved in or wi...
(EN_WEAK_ADJECTIVE)
[style] ~232-~232: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...t also outline what that member can and can not do as part of the investigation.
###...
(CAN_NOT_PREMIUM)
markdown/docs/community/050-mentorship-program/summerofcode/README.md
[style] ~10-~10: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ... contribute to open-source projects and improve their coding skills. If you want to dev...
(IMPROVE_STRENGTHEN)
[style] ~48-~48: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3495 characters long)
Context: ...I for your Google Summer of Code project!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
[style] ~80-~80: 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] ~82-~82: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ust be explicitly stated in the Scope. In case the total reward for all submitted...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~129-~129: Consider simply using “of” instead.
Context: ...nty Issue (on Monday, the last activity of any of the abovementioned types was four or mo...
(OF_ANY_OF)
[style] ~152-~152: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... Issue Timeline extension should happen prior to any current milestone of the Bounty Iss...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~178-~178: 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] ~180-~180: 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] ~182-~182: 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] ~200-~200: 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] ~221-~221: 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] ~221-~221: ‘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] ~221-~221: 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)
markdown/docs/community/020-governance-and-policies/voting.md
[style] ~17-~17: 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] ~19-~19: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... Pull Requests. The Discussions should only be used for initial discussion, brainst...
(ONLY_EXCLUSIVELY_STYLE)
markdown/docs/community/000-onboarding/github-actions.md
[style] ~99-~99: Consider a more expressive alternative.
Context: ...r to trigger it manually for you. To do this, reach out on Slack or open an iss...
(DO_ACHIEVE)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
[grammar] ~126-~126: Ensure spelling is correct
Context: ...ter/scripts/tools/categorylist.ts) from where you can opt the best category for your ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~126-~126: Ensure spelling is correct
Context: ...n opt the best category for your tools. Moreoever, if you don't find any, you can send us...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/070-marketing/webinar_series_initiative.md
[style] ~12-~12: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~39-~39: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/020-governance-and-policies/GOVERNANCE.md
[style] ~16-~16: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...duals to the board. - At least 60 days prior to elections, the Governance Board (GB) mu...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~42-~42: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...h perspectives. #### Interim Election In the event that a board member's term is terminated pri...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
[style] ~43-~43: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...hat a board member's term is terminated prior to its scheduled end, the organization sha...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[style] ~173-~173: 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)
markdown/docs/community/020-governance-and-policies/CHARTER.md
[style] ~40-~40: Consider a more concise word here.
Context: ...ze of TSC. The size is expected to vary in order to ensure adequate coverage of important a...
(IN_ORDER_TO_PREMIUM)
[style] ~71-~71: ‘a majority of the’ might be wordy. Consider a shorter alternative.
Context: ...can only be removed upon resignation or a majority of the TSC votes. Next steps will be specified...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF_THE)
[style] ~97-~97: ‘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] ~117-~117: 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] ~117-~117: 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] ~123-~123: ‘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] ~124-~124: 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] ~124-~124: ‘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] ~124-~124: 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] ~131-~131: Consider replacing this phrase with the adverb “professionally” to avoid wordiness.
Context: ... 1. Engage in the work of the Project in a professional manner consistent with maintaining a cohesive ...
(IN_A_X_MANNER)
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md
[uncategorized] ~53-~53: 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/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)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md
16-16: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
24-24: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
34-34: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
40-40: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
44-44: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
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)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
33-33: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
48-48: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
49-49: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
markdown/docs/community/050-mentorship-program/index.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
8-8: 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/application-template.md
12-12: 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
29-29: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
30-30: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md
23-23: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
23-23: Bare URL used
(MD034, no-bare-urls)
24-24: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
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)
33-33: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
35-35: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
36-36: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
9-9: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
22-22: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
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)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
78-78: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
88-88: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md
64-64: Bare URL used
(MD034, no-bare-urls)
67-67: Blank line inside blockquote
(MD028, no-blanks-blockquote)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
29-29: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
30-30: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
31-31: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
32-32: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
33-33: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
37-37: Images should have alternate text (alt text)
(MD045, no-alt-text)
108-108: Images should have alternate text (alt text)
(MD045, no-alt-text)
113-113: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
71-71: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
72-72: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
79-79: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
86-86: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
87-87: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
88-88: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
137-137: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
143-143: Headings must start at the beginning of the line
(MD023, heading-start-left)
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
21-21: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
27-27: Hard tabs
Column: 21
(MD010, no-hard-tabs)
29-29: Hard tabs
Column: 29
(MD010, no-hard-tabs)
46-46: 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/010-contribution-guidelines/BOUNTY_PROGRAM.md
31-31: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
31-31: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
40-40: Bare URL used
(MD034, no-bare-urls)
69-69: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
213-213: Bare URL used
(MD034, no-bare-urls)
253-253: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
253-253: Bare URL used
(MD034, no-bare-urls)
254-254: Bare URL used
(MD034, no-bare-urls)
255-255: Bare URL used
(MD034, no-bare-urls)
256-256: Bare URL used
(MD034, no-bare-urls)
257-257: Bare URL used
(MD034, no-bare-urls)
258-258: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/020-governance-and-policies/voting.md
40-40: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
markdown/docs/community/000-onboarding/github-actions.md
58-58: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
59-59: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
60-60: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
70-70: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
71-71: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
72-72: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
101-101: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/070-marketing/webinar_series_initiative.md
146-146: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
markdown/docs/community/020-governance-and-policies/GOVERNANCE.md
18-18: Bare URL used
(MD034, no-bare-urls)
77-77: Bare URL used
(MD034, no-bare-urls)
84-84: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
88-88: Bare URL used
(MD034, no-bare-urls)
90-90: Bare URL used
(MD034, no-bare-urls)
91-91: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
99-99: Bare URL used
(MD034, no-bare-urls)
100-100: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
21-21: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
22-22: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
52-52: Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
63-63: Images should have alternate text (alt text)
(MD045, no-alt-text)
67-67: Images should have alternate text (alt text)
(MD045, no-alt-text)
71-71: Images should have alternate text (alt text)
(MD045, no-alt-text)
75-75: Images should have alternate text (alt text)
(MD045, no-alt-text)
79-79: Images should have alternate text (alt text)
(MD045, no-alt-text)
89-89: Images should have alternate text (alt text)
(MD045, no-alt-text)
93-93: Images should have alternate text (alt text)
(MD045, no-alt-text)
97-97: Images should have alternate text (alt text)
(MD045, no-alt-text)
99-99: Images should have alternate text (alt text)
(MD045, no-alt-text)
101-101: Images should have alternate text (alt text)
(MD045, no-alt-text)
105-105: Images should have alternate text (alt text)
(MD045, no-alt-text)
109-109: Images should have alternate text (alt text)
(MD045, no-alt-text)
115-115: Images should have alternate text (alt text)
(MD045, no-alt-text)
122-122: Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
201-201: Bare URL used
(MD034, no-bare-urls)
209-209: Bare URL used
(MD034, no-bare-urls)
211-211: Bare URL used
(MD034, no-bare-urls)
213-213: Bare URL used
(MD034, no-bare-urls)
215-215: Bare URL used
(MD034, no-bare-urls)
217-217: Bare URL used
(MD034, no-bare-urls)
219-219: Bare URL used
(MD034, no-bare-urls)
221-221: Bare URL used
(MD034, no-bare-urls)
239-239: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
21-21: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
39-39: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
50-50: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
67-67: Bare URL used
(MD034, no-bare-urls)
73-73: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
104-104: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
122-122: Bare URL used
(MD034, no-bare-urls)
124-124: Bare URL used
(MD034, no-bare-urls)
130-130: Bare URL used
(MD034, no-bare-urls)
140-140: Bare URL used
(MD034, no-bare-urls)
146-146: Bare URL used
(MD034, no-bare-urls)
148-148: Bare URL used
(MD034, no-bare-urls)
154-154: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
23-23: Bare URL used
(MD034, no-bare-urls)
30-30: Bare URL used
(MD034, no-bare-urls)
48-48: Spaces inside link text
(MD039, no-space-in-links)
💤 Files with no reviewable changes (2)
- markdown/docs/community/styleguide/_section.md
- markdown/docs/community/onboarding-guide/_section.md
🧰 Additional context used
🧠 Learnings (36)
📓 Common learnings
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: TRohit20
PR: asyncapi/website#4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: asyncapi/website#4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
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: 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.
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/011-styleguide/links.md (6)
Learnt from: akshatnema
PR: #3262
File: components/Avatar.tsx:35-44
Timestamp: 2024-10-11T10:46:58.882Z
Learning: In Next.js, when avoiding nested <a> tags due to hydration issues, use accessible non-link elements like <button> or <span> with appropriate roles, tabIndex, and event handlers to maintain accessibility and SEO.
Learnt from: akshatnema
PR: #3262
File: components/newsroom/FeaturedBlogPost.tsx:90-92
Timestamp: 2024-10-11T07:38:35.745Z
Learning: In Next.js, nested <a> tags cause hydration issues due to invalid HTML. To fix this, avoid nesting <a> tags by replacing inner <a> tags with non-interactive elements like <span>, and use click handlers to maintain interactivity if needed.
Learnt from: akshatnema
PR: #3262
File: components/navigation/BlogPostItem.tsx:95-119
Timestamp: 2024-10-11T11:32:30.226Z
Learning: In the BlogPostItem component (components/navigation/BlogPostItem.tsx), nesting <a> tags inside the parent Link component leads to hydration issues; therefore, we should avoid nesting <a> tags inside Link components in this component.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: anshgoyalevil
PR: #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: #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/011-styleguide/grammar.md (2)
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: TRohit20
PR: #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/000-onboarding/index.md (4)
Learnt from: iambami
PR: #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: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: #3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the public prefix (e.g., use /img/avatars/... instead of /public/img/avatars/...).
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
markdown/docs/community/060-meetings-and-communication/docs-community.md (1)
Learnt from: iambami
PR: #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.
markdown/docs/community/010-contribution-guidelines/conventional-commits.md (4)
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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: akshatnema
PR: #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/maintainer-guide.md (3)
Learnt from: anshgoyalevil
PR: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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: #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: #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: #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: #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/011-styleguide/index.md (4)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: bandantonio
PR: #3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the public prefix (e.g., use /img/avatars/... instead of /public/img/avatars/...).
Learnt from: TRohit20
PR: #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/000-onboarding/ambassador-guide.md (1)
Learnt from: aminoxix
PR: #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/prerequisite-knowledge.md (1)
Learnt from: TRohit20
PR: #4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
/please-take-a-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/070-marketing/index.md (1)
Learnt from: anshgoyalevil
PR: #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/code-contributor-guide.md (5)
Learnt from: akshatnema
PR: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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: #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.
Learnt from: akshatnema
PR: #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.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
Learnt from: anshgoyalevil
PR: #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/contribution-flow.md (3)
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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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: akshatnema
PR: #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/010-contribution-guidelines/recognize-contributors.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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/040-guides/index.md (1)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (3)
Learnt from: iambami
PR: #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: #4074
File: markdown/blog/open-nest.md:11-12
Timestamp: 2025-04-28T01:13:59.084Z
Learning: For AsyncAPI blog posts, author photo filenames don't necessarily need to match the author's official name, as some authors may use pen names or nicknames (e.g., Aishat Muibudeen using "maya_picture.webp" for her avatar).
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
/please-take-a-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/010-contribution-guidelines/git-workflow.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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (2)
Learnt from: anshgoyalevil
PR: #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: #3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (2)
Learnt from: akshatnema
PR: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
Learnt from: anshgoyalevil
PR: #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: #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: #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/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
Learnt from: aminoxix
PR: #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/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md (1)
Learnt from: aminoxix
PR: #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/styleguide/localization.md (1)
Learnt from: anshgoyalevil
PR: #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.
markdown/docs/community/011-styleguide/styling.md (3)
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: TRohit20
PR: #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: bandantonio
PR: #3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the public prefix (e.g., use /img/avatars/... instead of /public/img/avatars/...).
markdown/docs/community/011-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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
markdown/docs/community/000-onboarding/github-actions.md (5)
Learnt from: akshatnema
PR: #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: #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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: anshgoyalevil
PR: #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: anshgoyalevil
PR: #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:
echo "key<<EOF" >> "${GITHUB_OUTPUT}"
echo "${value}" >> "${GITHUB_OUTPUT}"
echo "EOF" >> "${GITHUB_OUTPUT}"markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (4)
Learnt from: anshgoyalevil
PR: #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: #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: #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: #3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the tests/fixtures/tools/automated-tools.json file, the language field within the filters object can be either a string or an array. Both formats are acceptable and supported in the codebase.
markdown/docs/community/070-marketing/webinar_series_initiative.md (1)
Learnt from: iambami
PR: #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.
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-lookor/ptal: Requests attention from reviewers who haven't reviewed the PR/ready-to-mergeor/rtm: Triggers automerge when all conditions are met/do-not-mergeor/dnm: Blocks automerge even if all conditions are met/autoupdateor/au: Adds autoupdate label to keep PR in sync with target branch/updateor/u: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: #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/introduction-of-changes-to-spec.md (2)
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
🪛 LanguageTool
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...google.github.io/gsocguides/mentor/) - [Open Source Best Practices](https://opensource.guid...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
[style] ~14-~14: Consider using a synonym to be more concise.
Context: ...//github.com/AceTheCreator) | There are a lot of places where components need to be crea...
(A_LOT_OF)
[style] ~19-~19: 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] ~32-~32: 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] ~32-~32: 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/010-contribution-guidelines/recognize-contributors.md
[style] ~16-~16: 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] ~20-~20: ‘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] ~22-~22: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... if we failed in recognizing your work. Feel free to contact us on [slack](https://asyncapi....
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
[style] ~18-~18: 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/010-contribution-guidelines/identifying-good-first-issues.md
[style] ~79-~79: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4168 characters long)
Context: ...d let's build something awesome together!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/050-mentorship-program/README.md
[style] ~8-~8: 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/winterofcode/2023/README.md
[grammar] ~7-~7: Ensure spelling is correct
Context: ...us: In Progress > Program participation annoucement can be found here https://github.com/or...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
[style] ~22-~22: Phrases like “ I think we” can make your message sound insecure. Consider making your writing sound more confident and self-assured.
Context: ...hrow exceptions from the main function. I think we should standardize this and propose a system b...
(I_THINK_WE_SHOULD)
[style] ~25-~25: Consider using a synonym to be more concise.
Context: ...y and we use GitHub Actions to automate lots of things in the organization. GitHub acti...
(A_LOT_OF)
[style] ~27-~27: Consider a different adjective to strengthen your wording.
Context: ...ub.com/asyncapi/cli) | @fmvilas | We're doing a great job at Glee and Generator and it's about th...
(DO_A_GREAT_JOB)
[grammar] ~29-~29: Ensure spelling is correct
Context: ...eople and companies doing serverless or Fuction-as-a-Service (FaaS). Making Glee integr...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~30-~30: ‘in difficulty’ might be wordy. Consider a shorter alternative.
Context: ... is probably the most complicated issue in difficulty. If we want people to adopt Glee in pro...
(EN_WORDINESS_PREMIUM_IN_DIFFICULTY)
[grammar] ~30-~30: Ensure spelling is correct
Context: ...dopt Glee in production, it needs to be prodution-ready, and that means being able to han...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md
[uncategorized] ~49-~49: 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)
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md
[style] ~7-~7: 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/050-mentorship-program/seasonofdocs/2023/project-ideas.md
[style] ~28-~28: 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
[grammar] ~18-~18: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~32-~32: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[style] ~58-~58: ‘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] ~63-~63: 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)
markdown/docs/community/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md
[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...come ambassadors for the whole year. 3. If you were accepted as ambassador on the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~46-~46: ‘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] ~61-~61: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...he process of becoming an ambassador is very simple. Go to the community repository and...
(EN_WEAK_ADJECTIVE)
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md
[style] ~12-~12: Consider replacing this phrase with the adverb “transparently” to avoid wordiness.
Context: ...s have a voice and that the group works in a transparent manner. Multiple chairpersons can be elected i...
(IN_A_X_MANNER)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
[grammar] ~79-~79: Ensure spelling is correct
Context: ... In that case, AsyncAPI may require the Progam Administrators to designate a replacement Mentor and r...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~99-~99: Ensure spelling is correct
Context: ...iewed by the selected project Mentor to which they were submitted. A Mentor may accep...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[uncategorized] ~111-~111: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...licly accessible location and under an [Open Source Initiative approved license](http://www...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
[style] ~45-~45: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...e to projects under AsyncAPI Initiative on a regular basis, and we'll welcome them as new maintain...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
[style] ~112-~112: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...r=blue" width=300 /> ### Contact Feel free to contact us if you need more explanation...
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/020-governance-and-policies/donating-projects.md
[style] ~24-~24: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...r both maintainers and contributors. - We make Intellectual Property (IP) Review ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
[uncategorized] ~55-~55: 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)
[style] ~107-~107: This phrase is redundant (‘O’ stands for ‘Optimization’). Use simply “SEO”.
Context: ... | ## Website Traffic Growth ### SEO Optimization - Improve AsyncAPI website SEO with hi...
(ACRONYM_TAUTOLOGY)
markdown/docs/community/011-styleguide/styling.md
[style] ~87-~87: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ions. - Use one declaration per line. - Use a trailing semi-colon ; on the last d...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
[style] ~49-~49: 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] ~49-~49: 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] ~53-~53: Consider using an en dash here instead of a hyphen.
Context: ...t each new TW contributor started. - June - August: Each TW goes through designate...
(QB_NEW_EN_DASH_RULE_EN)
[typographical] ~54-~54: Consider using an en dash here instead of a hyphen.
Context: ... for the issues assigned/selected. - September - October: We determine if we can comple...
(QB_NEW_EN_DASH_RULE_EN)
[style] ~59-~59: 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/seasonofdocs/2022/README.md
[typographical] ~28-~28: Consider using an en dash here instead of a hyphen.
Context: ...or their issues assigned/selected. - September - October: We determined if we could com...
(QB_NEW_EN_DASH_RULE_EN)
markdown/docs/community/COC-incident-resolution-procedures.md
[style] ~97-~97: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ... the nature of the allegations, if any, taking into consideration risks of retaliation, evidence tamperin...
(TAKE_INTO_CONSIDERATION)
[style] ~107-~107: ‘mutual agreement’ might be wordy. Consider a shorter alternative.
Context: ...torative Justice" below), mediation, or mutual agreement, the CoC Committee will wait until the ...
(EN_WORDINESS_PREMIUM_MUTUAL_AGREEMENT)
[style] ~107-~107: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tor may help facilitate the discussion. If the involved parties agree on an outcom...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~191-~191: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ided information, if only one person or a very small number of people were involved in or wi...
(EN_WEAK_ADJECTIVE)
[style] ~232-~232: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...t also outline what that member can and can not do as part of the investigation.
###...
(CAN_NOT_PREMIUM)
markdown/docs/community/050-mentorship-program/summerofcode/README.md
[style] ~10-~10: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ... contribute to open-source projects and improve their coding skills. If you want to dev...
(IMPROVE_STRENGTHEN)
[style] ~48-~48: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3495 characters long)
Context: ...I for your Google Summer of Code project!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
[style] ~80-~80: 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] ~82-~82: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ust be explicitly stated in the Scope. In case the total reward for all submitted...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~129-~129: Consider simply using “of” instead.
Context: ...nty Issue (on Monday, the last activity of any of the abovementioned types was four or mo...
(OF_ANY_OF)
[style] ~152-~152: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... Issue Timeline extension should happen prior to any current milestone of the Bounty Iss...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~178-~178: 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] ~180-~180: 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] ~182-~182: 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] ~200-~200: 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] ~221-~221: 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] ~221-~221: ‘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] ~221-~221: 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)
markdown/docs/community/020-governance-and-policies/voting.md
[style] ~17-~17: 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] ~19-~19: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... Pull Requests. The Discussions should only be used for initial discussion, brainst...
(ONLY_EXCLUSIVELY_STYLE)
markdown/docs/community/000-onboarding/github-actions.md
[style] ~99-~99: Consider a more expressive alternative.
Context: ...r to trigger it manually for you. To do this, reach out on Slack or open an iss...
(DO_ACHIEVE)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
[grammar] ~126-~126: Ensure spelling is correct
Context: ...ter/scripts/tools/categorylist.ts) from where you can opt the best category for your ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~126-~126: Ensure spelling is correct
Context: ...n opt the best category for your tools. Moreoever, if you don't find any, you can send us...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/070-marketing/webinar_series_initiative.md
[style] ~12-~12: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~39-~39: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/020-governance-and-policies/GOVERNANCE.md
[style] ~16-~16: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...duals to the board. - At least 60 days prior to elections, the Governance Board (GB) mu...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~42-~42: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...h perspectives. #### Interim Election In the event that a board member's term is terminated pri...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
[style] ~43-~43: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...hat a board member's term is terminated prior to its scheduled end, the organization sha...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[style] ~173-~173: 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)
markdown/docs/community/020-governance-and-policies/CHARTER.md
[style] ~40-~40: Consider a more concise word here.
Context: ...ze of TSC. The size is expected to vary in order to ensure adequate coverage of important a...
(IN_ORDER_TO_PREMIUM)
[style] ~71-~71: ‘a majority of the’ might be wordy. Consider a shorter alternative.
Context: ...can only be removed upon resignation or a majority of the TSC votes. Next steps will be specified...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF_THE)
[style] ~97-~97: ‘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] ~117-~117: 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] ~117-~117: 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] ~123-~123: ‘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] ~124-~124: 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] ~124-~124: ‘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] ~124-~124: 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] ~131-~131: Consider replacing this phrase with the adverb “professionally” to avoid wordiness.
Context: ... 1. Engage in the work of the Project in a professional manner consistent with maintaining a cohesive ...
(IN_A_X_MANNER)
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md
[uncategorized] ~53-~53: 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/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)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md
16-16: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
24-24: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
34-34: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
40-40: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
44-44: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
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)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
33-33: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
48-48: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
49-49: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
markdown/docs/community/050-mentorship-program/index.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
8-8: 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/application-template.md
12-12: 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
29-29: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
30-30: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md
23-23: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
23-23: Bare URL used
(MD034, no-bare-urls)
24-24: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
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)
33-33: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
35-35: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
36-36: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
9-9: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
22-22: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
11-11: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
13-13: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
13-13: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
16-16: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
16-16: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
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)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
78-78: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
88-88: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md
64-64: Bare URL used
(MD034, no-bare-urls)
67-67: Blank line inside blockquote
(MD028, no-blanks-blockquote)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
29-29: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
30-30: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
31-31: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
32-32: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
33-33: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
37-37: Images should have alternate text (alt text)
(MD045, no-alt-text)
108-108: Images should have alternate text (alt text)
(MD045, no-alt-text)
113-113: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
71-71: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
72-72: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
79-79: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
86-86: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
87-87: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
88-88: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
137-137: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
143-143: Headings must start at the beginning of the line
(MD023, heading-start-left)
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
21-21: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
27-27: Hard tabs
Column: 21
(MD010, no-hard-tabs)
29-29: Hard tabs
Column: 29
(MD010, no-hard-tabs)
46-46: 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/010-contribution-guidelines/BOUNTY_PROGRAM.md
31-31: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
31-31: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
40-40: Bare URL used
(MD034, no-bare-urls)
69-69: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
213-213: Bare URL used
(MD034, no-bare-urls)
253-253: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
253-253: Bare URL used
(MD034, no-bare-urls)
254-254: Bare URL used
(MD034, no-bare-urls)
255-255: Bare URL used
(MD034, no-bare-urls)
256-256: Bare URL used
(MD034, no-bare-urls)
257-257: Bare URL used
(MD034, no-bare-urls)
258-258: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/020-governance-and-policies/voting.md
40-40: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
markdown/docs/community/000-onboarding/github-actions.md
58-58: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
59-59: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
60-60: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
70-70: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
71-71: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
72-72: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
101-101: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/070-marketing/webinar_series_initiative.md
146-146: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
markdown/docs/community/020-governance-and-policies/GOVERNANCE.md
18-18: Bare URL used
(MD034, no-bare-urls)
77-77: Bare URL used
(MD034, no-bare-urls)
84-84: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
88-88: Bare URL used
(MD034, no-bare-urls)
90-90: Bare URL used
(MD034, no-bare-urls)
91-91: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
99-99: Bare URL used
(MD034, no-bare-urls)
100-100: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
21-21: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
22-22: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
52-52: Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
63-63: Images should have alternate text (alt text)
(MD045, no-alt-text)
67-67: Images should have alternate text (alt text)
(MD045, no-alt-text)
71-71: Images should have alternate text (alt text)
(MD045, no-alt-text)
75-75: Images should have alternate text (alt text)
(MD045, no-alt-text)
79-79: Images should have alternate text (alt text)
(MD045, no-alt-text)
89-89: Images should have alternate text (alt text)
(MD045, no-alt-text)
93-93: Images should have alternate text (alt text)
(MD045, no-alt-text)
97-97: Images should have alternate text (alt text)
(MD045, no-alt-text)
99-99: Images should have alternate text (alt text)
(MD045, no-alt-text)
101-101: Images should have alternate text (alt text)
(MD045, no-alt-text)
105-105: Images should have alternate text (alt text)
(MD045, no-alt-text)
109-109: Images should have alternate text (alt text)
(MD045, no-alt-text)
115-115: Images should have alternate text (alt text)
(MD045, no-alt-text)
122-122: Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
201-201: Bare URL used
(MD034, no-bare-urls)
209-209: Bare URL used
(MD034, no-bare-urls)
211-211: Bare URL used
(MD034, no-bare-urls)
213-213: Bare URL used
(MD034, no-bare-urls)
215-215: Bare URL used
(MD034, no-bare-urls)
217-217: Bare URL used
(MD034, no-bare-urls)
219-219: Bare URL used
(MD034, no-bare-urls)
221-221: Bare URL used
(MD034, no-bare-urls)
239-239: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
21-21: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
39-39: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
50-50: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
67-67: Bare URL used
(MD034, no-bare-urls)
73-73: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
104-104: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
122-122: Bare URL used
(MD034, no-bare-urls)
124-124: Bare URL used
(MD034, no-bare-urls)
130-130: Bare URL used
(MD034, no-bare-urls)
140-140: Bare URL used
(MD034, no-bare-urls)
146-146: Bare URL used
(MD034, no-bare-urls)
148-148: Bare URL used
(MD034, no-bare-urls)
154-154: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md
23-23: Bare URL used
(MD034, no-bare-urls)
30-30: Bare URL used
(MD034, no-bare-urls)
48-48: Spaces inside link text
(MD039, no-space-in-links)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (58)
markdown/docs/community/011-styleguide/formatting.md (1)
4-4: Updatedweightfront-matter looks goodRe-ordering to
100keeps the Style Guide sequence consistent with the new_section.mdbaseline. No further action needed.markdown/docs/community/011-styleguide/glossary.md (1)
4-4: Front-matterweightadjusted correctlyDropping to
160maintains the ascending order of topics—no issues spotted.markdown/docs/community/011-styleguide/numbers.md (1)
4-4:weight: 80change aligns with new orderingThe shift preserves logical ordering between “Grammar” (70) and “Punctuation” (90). Good to merge.
markdown/docs/community/011-styleguide/content-buckets.md (1)
3-4: Front-matter tidy-up approved• Key renamed to lowercase
descriptionfor consistency.
•weightbumped to40, correctly placing the doc after the section intro (30).markdown/docs/community/011-styleguide/seo-guide.md (1)
4-4: SEO guide weight tweak acknowledgedSetting
weightto130fits the updated hierarchy. No further feedback.markdown/docs/community/010-contribution-guidelines/contribute-to-docs.md (1)
3-3: Front-matter weight update looks correct.The new value (80) cleanly re-orders the doc within its section. No further action needed.
markdown/docs/community/011-styleguide/voice-and-tone.md (1)
4-4: Weight adjustment acknowledged.Changing the weight to 60 keeps ordering consistent with the revamped style-guide structure.
markdown/docs/community/011-styleguide/inclusive-language.md (1)
4-4: Weight metadata updated.Setting weight to 50 fits the new hierarchy; content remains intact.
markdown/docs/community/011-styleguide/links.md (1)
4-4: Ordering tweak confirmed.The updated weight (120) maintains sequential positioning among sibling docs.
markdown/docs/community/011-styleguide/punctuation.md (1)
4-4: Weight change verified.Lowering to 90 aligns with the section’s revised order. Nothing else to flag.
markdown/docs/community/010-contribution-guidelines/technical-writer-contributor-responsibilities.md (1)
2-3: Check weight consistency within010-contribution-guidelinessection
Raising theweightto 100 will push this page to the very bottom of the sidebar list for the section, which may not match the intended reading order (most other documents keep weights ≤ 40). Double-check neighbouring files’ weights before merging.markdown/docs/community/060-meetings-and-communication/docs-community.md (2)
3-3: Weight lowered to 20 – verify there are no duplicates
If any other file in060-meetings-and-communicationalso uses weight 20, the build will emit non-deterministic ordering. Please confirm uniqueness.
10-10: Relative link looks good – but ensure the target file is exported
MEETINGS_ORGANIZATION.mdsits in the same directory, so the link should resolve. Run the Markdown link checker to confirm there is no trailing slash issue.markdown/docs/community/011-styleguide/_section.md (1)
1-4: Section metadata OK
Title and weight follow established pattern; no concerns.markdown/docs/community/070-marketing/_section.md (1)
1-4: Section registered – verify global ordering
Weight 90 will position Marketing after Mentorship (80) and before anything > 90. Make sure this matches the intended navigation flow.markdown/docs/community/000-onboarding/index.md (1)
2-3: Lower weight to 5 – confirm no clash with_section.md
If the section file for onboarding already uses weight 5, having the index at the same weight could reorder unpredictably.markdown/docs/community/010-contribution-guidelines/prerequisite-knowledge.md (2)
2-3: Confirm new weight doesn’t clash with siblings
Changingweightfrom 40 → 10 will push this page to the very top of the Contribution-Guidelines list. Double-check that no other file in the same folder already uses 10, otherwise the ordering becomes nondeterministic in Hugo/Next.
8-15: Accent in “Diátaxis” may break auto-generated anchors
Some site generators strip diacritics differently, producing anchors such as#diátaxis-frameworkvs#diataxis-framework. If you intend to deep-link to this heading from other docs, verify that the generated ID is the one you expect.markdown/docs/community/000-onboarding/_section.md (1)
1-4: Section front-matter looks good
No issues spotted—metadata is minimal and valid.markdown/docs/community/040-guides/_section.md (1)
1-4: Section added correctly
Front-matter is well-formed;weight: 60leaves plenty of room for future sections.markdown/docs/community/010-contribution-guidelines/_section.md (1)
1-4: Section metadata OK
Nothing blocking here.markdown/docs/community/011-styleguide/index.md (1)
2-3: Title change LGTM
Removing the quotes is harmless and keeps front-matter consistent.markdown/docs/community/010-contribution-guidelines/create-new-docs-directories.md (1)
2-3: Front-matter update looks correct, but verify weight collision with siblingsThe unquoted title and the increased weight are YAML-valid and align with other files, but bumping weight from 80 → 120 may reorder the page unexpectedly within
010-contribution-guidelines/. Double-check that no other page now has the same weight or an out-of-order gap.markdown/docs/community/020-governance-and-policies/_section.md (1)
1-4: Section metadata LGTMTitle and weight follow existing conventions. No further action needed.
markdown/docs/community/011-styleguide/grammar.md (2)
4-4: Weight lowered—check ordering with adjacent style-guide docsChanging weight 100 → 70 re-orders this page. Ensure other files in
011-styleguide/have distinct, ascending weights so the sidebar reflects the intended sequence.
75-76: Removed stray dash — good catchFix eliminates a malformed list item and keeps markdown parsers happy.
markdown/docs/community/060-meetings-and-communication/_section.md (1)
1-4: New section metadata looks fineConsistent casing and a unique weight; no issues spotted.
markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.md (1)
2-3: Title capitalization & weight bump approved; validate sidebar orderThe YAML is syntactically sound. Just confirm that weight 110 places the page where you expect relative to its peers.
markdown/docs/community/030-project-vision-strategy-goals/_section.md (1)
1-5: Front-matter looks goodTitle/weight front-matter is correct and consistent with the other section index files.
No issues spotted.markdown/docs/community/010-contribution-guidelines/tools-and-setup.md (1)
23-23: Verify the new relative link targets an existing fileThe link now points to
git-workflow.md. That file should live in the same010-contribution-guidelinesdirectory.
Please confirm it exists (or will land in the same PR) so the reference is not broken.markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
2-2: Title capitalisation okTitle updated to Title-Case; matches style used elsewhere.
markdown/docs/community/000-onboarding/maintainer-guide.md (2)
3-3: Front-matter weight change looks correct
Moving the guide earlier in the sidebar (#40) aligns with the overall ordering of the new community docs. No concerns.
49-49: Please double-check the new relative link
../010-contribution-guidelines/git-workflow.mdshould resolve from000-onboarding/maintainer-guide.mdto a sibling folder. Verify the file actually exists after build; broken links hurt navigation.markdown/docs/community/050-mentorship-program/_section.md (1)
1-4: Section metadata LGTM
Title and weight are consistent with neighbouring community sections.markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (3)
4-4: Weight updated — ensure ordering stays intentional
At70, this guide now appears earlier than several others (e.g., “Maintainer Guide” also at 70). Check for duplicate weights that may create nondeterministic ordering in some build targets.
16-16: Good switch to relative link
Keeping links internal improves portability and edit-link UX. No issues.
22-23: Relative path to CONTRIBUTING may be wrong
../../CONTRIBUTING.mdresolves tomarkdown/docs/community/CONTRIBUTING.md. The project’s canonical file lives at the repo root (/CONTRIBUTING.md). Confirm the path after build; otherwise visitors will hit a 404.markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
2-4: Weight change may create ordering clash
weight: 20is now very low (previously 130).
Verify that no other file in the same section already uses20; duplicate weights can make ordering nondeterministic in some static-site generators.markdown/docs/community/070-marketing/index.md (1)
6-13: LGTM – clear, well-scoped outlineContent is concise and well structured; no issues spotted.
markdown/docs/community/040-guides/index.md (1)
6-23: Nice, concise overview – no blocking issues spotted
The structure and internal links look good.markdown/docs/community/060-meetings-and-communication/index.md (1)
6-30: Looks good – clear and well-structured
No issues found.markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
46-48: Verify relative link toTSC_BOARD_MEMBERS.yaml
../../TSC_BOARD_MEMBERS.yamlresolves tomarkdown/docs/community/TSC_BOARD_MEMBERS.yaml. Confirm the file exists at that path; otherwise the link will 404.markdown/docs/community/030-project-vision-strategy-goals/index.md (1)
1-24: Document structure looks goodFront-matter, heading hierarchy, and list formatting render correctly and pass basic markdownlint checks.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
12-12: Relative link sanity-check
../060-meetings-and-communication/slack-etiquette.mdlooks correct, but make sure the file indeed lives under060-meetings-and-communication/after this refactor; otherwise the checklist breaks.markdown/docs/community/050-mentorship-program/README.md (1)
17-20: Consider pointing to AsyncAPI’s own discussion board instead of CNCF’s.The link currently goes to
github.com/cncf/mentoring/discussions, but the surrounding copy suggests AsyncAPI-specific support channels.
If the intention is to direct readers to the AsyncAPI community board, replace withhttps://github.com/asyncapi/community/discussions.markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
45-52: Link points to an archived repository – verify availability.
https://github.com/asyncapi-archived-repos/design-system/issues/4may confuse newcomers if the repo is read-only.
Confirm that work will indeed happen in the archived repo or update the link to the active successor.markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md (1)
70-77: Relative link may break when rendered
[git workflow guide](git-workflow.md)assumes the guide is in the same directory.
If the file lives elsewhere (e.g., parent folder), adjust the relative path so static-site build does not emit broken links.markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
20-22: Branch name “master” may be outdatedMany AsyncAPI repos now use
main. Confirm current default branch names and adjust examples (git branch -u upstream/main main, PRs againstmain, etc.) to prevent contributor confusion.markdown/docs/community/050-mentorship-program/summerofcode/README.md (1)
34-35: Double-check relative link correctness
[ideas page](2024/asyncapi-gsoc-ideas-page.md)resolves relative to the current file’s directory.
If the 2024 folder actually lives insidesummerofcode/, this is fine.
If it lives one level up (parallel tosummerofcode/), prepend../. Broken links hurt the docs UX.markdown/docs/community/020-governance-and-policies/voting.md (1)
26-31: Quorum calculation wording can confuse readersThe example mixes “majority” and “quorum”. You first say quorum is >50 % of votes in favour, but the example then multiplies total members by 51 %.
Quorum = minimum participation; majority = minimum in-favour votes. Consider rephrasing to avoid conflating the two concepts.markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (1)
28-33: Trailing pipes in table break some Markdown renderersRemove the ending
|on each data row to comply with MD055 and ensure consistent rendering across GitHub, Docusaurus, etc.markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md (1)
64-70: Broken or missing links should be verified
MAINTAINERS.yaml,Maintainer Onboarding Guide, and Charter URLs point tomasterand specific sub-paths that might have moved during the docs re-structure. Please click-through before merge to avoid 404s or future drift.markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1)
21-23: Weight collisionThis guide has
weight: 20, which is identical to the Webinar doc in the same section. Double-check front-matter ordering rules; duplicate weights sometimes lead to unstable TOC ordering in Docusaurus/Next docs builds.markdown/docs/community/070-marketing/webinar_series_initiative.md (1)
41-50: Numericweightis wrapped in quotesFront-matter uses
weight: "20"(string) whereas other docs use an int. Mixed types can break sorting logic in some generators. Convert to plain number for consistency.markdown/docs/community/020-governance-and-policies/GOVERNANCE.md (1)
8-11: Verify relative links to YAML sourcesThe links to
../../MAINTAINERS.yamland../../AMBASSADORS_MEMBERS.yamlrely on a two-level relative path.
Given this file resides inmarkdown/docs/community/020-governance-and-policies/, the resolved path will bemarkdown/docs/community/MAINTAINERS.yaml, which does not exist in the tree introduced by this PR. Broken links will 404 on the website build.
Please double-check the path or replace with the canonical GitHub URL.markdown/docs/community/COC-incident-resolution-procedures.md (1)
200-240: Hard vs. soft conflict rules are clear – nice work
The distinction and required disclosures are explicit and actionable.markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (1)
23-25: Good guard-rail on WG authority
Explicitly stating that WGs cannot overrule maintainers prevents expectation mismatches. 👍markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
150-163: Cancel-meeting automation well documented – great clarity
The step-by-step explanation combined with the GitHub-Action trigger makes the process easy to follow.
|
|
||
| ### Additional resources | ||
| [AsyncAPI Ambassador Program](https://github.com/asyncapi/community/blob/master/AMBASSADOR_ORGANIZATION.md) | ||
| [AsyncAPI Ambassador Program](../050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Potential broken link – path looks off
../050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md navigates:
- up to
community/ - into
050-mentorship-program/…
The Ambassador Program file described in the PR summary is under 020-governance-and-policies/ambassador-program/.
Please verify the actual location or adjust the link accordingly to avoid a 404.
I’ll locate the actual AMBASSADOR_PROGRAM.md files to verify the correct path:
🏁 Script executed:
#!/bin/bash
# Find all occurrences of the Ambassador Program markdown
fd AMBASSADOR_PROGRAM.mdLength of output: 119
Fix broken link – update path to Ambassador Program doc
The link currently points to the non-existent 050-mentorship-program folder. The correct file location is under 020-governance-and-policies.
• File: markdown/docs/community/000-onboarding/ambassador-guide.md
• Line: 41
Diff:
-[AsyncAPI Ambassador Program](../050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md)
+[AsyncAPI Ambassador Program](../020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [AsyncAPI Ambassador Program](../050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md) | |
| [AsyncAPI Ambassador Program](../020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md) |
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/ambassador-guide.md at line 41, the
link to the Ambassador Program document points to a non-existent folder
050-mentorship-program. Update the link path to point to the correct location
under 020-governance-and-policies to fix the broken link.
|
|
||
| - [ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md). | ||
| - [ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md). | ||
| - [ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Default branch is main, not master
The Code of Conduct URL still targets .../blob/master/.... AsyncAPI switched to main quite a while ago. Update to avoid a 404 if/when master is removed.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/docs-onboarding-checklist.md at line
11, the URL for the AsyncAPI Code of Conduct references the default branch as
'master', which is outdated. Update the URL to replace 'master' with 'main' to
reflect the current default branch and prevent potential 404 errors.
| The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively. | ||
|
|
||
| > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md). | ||
| > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md). |
There was a problem hiding this comment.
💡 Verification agent
🛠️ Refactor suggestion
🧩 Analysis chain
Relative link may resolve to a non-existent path
../../CONTRIBUTING.md from markdown/docs/community/000-onboarding/ points to markdown/docs/CONTRIBUTING.md. The actual contributing guide in this repo is at the repo root (/CONTRIBUTING.md). Consider using ../../../CONTRIBUTING.md or an absolute site URL to avoid a broken link.
🏁 Script executed:
#!/bin/bash
set -e
echo "=== All CONTRIBUTING.md files in repository ==="
rg --files | grep -i "contributing.md" || echo "No CONTRIBUTING.md found"
echo
echo "=== CONTRIBUTING.md under markdown/docs ==="
rg --files markdown/docs | grep -i "contributing.md" || echo "None under markdown/docs"Length of output: 385
Fix broken CONTRIBUTING.md link
The relative link ../../CONTRIBUTING.md in markdown/docs/community/000-onboarding/index.md:9 resolves to markdown/docs/CONTRIBUTING.md, which doesn’t exist. To point to the repo-root CONTRIBUTING.md, either:
- Change the path to four levels up:
../../../../CONTRIBUTING.md - Use an absolute URL (e.g.
https://github.com/asyncapi/website/blob/main/CONTRIBUTING.md)
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/index.md at line 9, the relative link
to CONTRIBUTING.md is incorrect and resolves to a non-existent path. Fix this by
updating the link to either go four levels up using ../../../../CONTRIBUTING.md
or replace it with the absolute URL to the CONTRIBUTING.md file in the
repository root.
| To maintain a clear and structured commit history, all PR titles must follow the Conventional Commits format. This ensures that commit messages and PRs are semantically meaningful and easy to understand. | ||
|
|
||
| A PR title that does not follow this format will be rejected by our [Linting bot](https://github.com/asyncapi/community/blob/master/.github/workflows/lint-pr-title.yml), preventing the PR from being merged. | ||
| A PR title that does not follow this format will be rejected by our [Linting bot](../../.github/workflows/lint-pr-title.yml), preventing the PR from being merged. |
There was a problem hiding this comment.
Broken relative path to workflow file
../../.github/workflows/lint-pr-title.yml
From markdown/docs/community/010-contribution-guidelines/, ../../ brings you to markdown/docs/.
.github sits at repo root, so the correct relative path needs four .. components:
../../../../.github/workflows/lint-pr-title.yml
Incorrect path will render as a dead link on the site.
Happy to suggest the corrected relative URL if needed.
🤖 Prompt for AI Agents
In markdown/docs/community/010-contribution-guidelines/conventional-commits.md
at line 45, the relative path to the linting workflow file is incorrect and
leads to a dead link. Update the path from
../../.github/workflows/lint-pr-title.yml to
../../../../.github/workflows/lint-pr-title.yml to correctly point to the
.github directory at the repository root.
|  | ||
|
|
||
| 2. Click on the **"Issues"** tab of a repository. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 3. Use the search bar or label filters to locate issues labeled like: `good first issue` or `help wanted`. | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Images lack meaningful alt text
The three inline screenshots use the filename as alt text (Screenshot …).
For accessibility, replace with descriptive alt text such as “GitHub organization page with repositories list”.
🤖 Prompt for AI Agents
In
markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md
around lines 28 to 38, the alt text for the three inline screenshots is
currently just the filename, which is not descriptive. Replace each alt
attribute with meaningful descriptions that convey the content of the images,
such as "GitHub organization page with repositories list," "GitHub repository
Issues tab," and "GitHub Issues page with search bar and label filters," to
improve accessibility.
| ### Contact information | ||
|
|
||
| Please provide your most basic contact information, such as: | ||
| - Full name | ||
| - Email address | ||
| - GitHub handle | ||
| - Contact Number(include your country code) |
There was a problem hiding this comment.
Heading level jumps from H1 → H3
After the top-level # GSoC Application Template, the next heading should be ##, not ###, to preserve hierarchy (MD001). Adjust all subsequent sub-sections accordingly.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
In
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md
around lines 12 to 18, the heading level jumps from H1 (#) directly to H3 (###),
which breaks the heading hierarchy. Change the "### Contact information" heading
to "## Contact information" to maintain proper heading structure, and adjust any
subsequent sub-headings accordingly to preserve the hierarchy.
| # GSoC Mentor's Guideline | ||
|
|
||
| ##### Introduction | ||
|
|
||
| Hey there! Welcome to the Google Summer of Code (GSoC) mentors' guideline. As a mentor, you are crucial in guiding and supporting contributors throughout their GSoC journey. This guideline outlines key responsibilities, best practices, and tips to ensure a successful mentoring experience. |
There was a problem hiding this comment.
Heading level jumps from H1 to H5
##### Introduction should be ## Introduction (or ###) to avoid MD001 violations and keep a logical hierarchy.
-##### Introduction
+## Introduction📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # GSoC Mentor's Guideline | |
| ##### Introduction | |
| Hey there! Welcome to the Google Summer of Code (GSoC) mentors' guideline. As a mentor, you are crucial in guiding and supporting contributors throughout their GSoC journey. This guideline outlines key responsibilities, best practices, and tips to ensure a successful mentoring experience. | |
| # GSoC Mentor's Guideline | |
| ## Introduction | |
| Hey there! Welcome to the Google Summer of Code (GSoC) mentors' guideline. As a mentor, you are crucial in guiding and supporting contributors throughout their GSoC journey. This guideline outlines key responsibilities, best practices, and tips to ensure a successful mentoring experience. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Heading levels should only increment by one level at a time
Expected: h2; Actual: h6
(MD001, heading-increment)
🤖 Prompt for AI Agents
In
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
between lines 6 and 10, the heading level jumps from H1 to H5, which breaks the
logical heading hierarchy. Change the `##### Introduction` heading to `##
Introduction` or `### Introduction` to maintain proper markdown heading
structure and avoid MD001 linting violations.
| <img src="../../assets/meetings/restream1.png" width="50%"> | ||
|
|
||
| 1. Click `Update Titles` card: | ||
|
|
||
| <img src="../../assets/meetings/restream2.png" width="50%"> | ||
|
|
||
| 1. Provide title and description: | ||
|
|
||
| - Title for the live stream that corresponds with the meeting you just started, | ||
| - Meeting description must be provided even if the field is empty; otherwise, the old one from other streams will be used. | ||
|
|
||
| <img src="../../assets/meetings/restream3.png" width="50%"> | ||
|
|
||
| 1. In Zoom, click the `Live Transcript` button to start transcribing the meeting: | ||
|
|
||
|  | ||
|
|
||
| 1. Confirm transcriptions with `Enable` button: | ||
|
|
||
|  | ||
|
|
||
| 1. Click `More`: | ||
|
|
||
|  | ||
|
|
||
| 1. Select `Live on Custom Live Stream Service` option to start streaming to Restream and, therefore, to official AsyncAPI social networks: | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Add alt text to all illustrative images
Every image reference (<img …>, ![]()) lacks alt text, violating MD045 and blocking assistive technologies.
Recommend adding concise alt text, e.g.:
<img src="restream1.png" width="50%" alt="Restream homepage with 'Set up for OBS, Zoom' highlighted">Same for the subsequent screenshots.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
52-52: Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
63-63: Images should have alternate text (alt text)
(MD045, no-alt-text)
67-67: Images should have alternate text (alt text)
(MD045, no-alt-text)
71-71: Images should have alternate text (alt text)
(MD045, no-alt-text)
75-75: Images should have alternate text (alt text)
(MD045, no-alt-text)
79-79: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
between lines 52 and 80, all image tags lack alt text, which violates
accessibility standards. Add concise and descriptive alt attributes to each
<img> tag and markdown image reference to improve accessibility and comply with
MD045. For example, include alt text that briefly describes the image content
relevant to the instructions shown.
| --- | ||
| title: "AsyncAPI Webinar Planning Template" | ||
| weight: "30" | ||
| --- |
There was a problem hiding this comment.
Use numeric value for weight front-matter
Front-matter weight is a string ("30").
Other docs use an integer (e.g., weight: 5). Mixing types can break some static-site generators’ sorting logic.
-weight: "30"
+weight: 30📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| title: "AsyncAPI Webinar Planning Template" | |
| weight: "30" | |
| --- | |
| --- | |
| title: "AsyncAPI Webinar Planning Template" | |
| weight: 30 | |
| --- |
🤖 Prompt for AI Agents
In markdown/docs/community/070-marketing/webinar_planning_template.md lines 1 to
4, the front-matter `weight` is currently a string ("30"). Change it to a
numeric value without quotes (e.g., weight: 30) to ensure consistent sorting
behavior in static-site generators.
| - [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) | ||
| - [Resolution](#resolution) | ||
| - [Interim Protective Measures](#interim-protective-measures) |
There was a problem hiding this comment.
Indentation off – lists render incorrectly
The second-level bullets under “What happens after a report is submitted” use inconsistent 1-3 space indents, tripping MD005/MD007.
In GitHub Markdown this collapses some items into plain text, harming TOC generation.
Realign all nested bullets to exactly two spaces per level (or use tabs consistently) to keep structure intact.
🧰 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 18, the indentation of second-level bullet points under "What happens after a
report is submitted" is inconsistent, causing rendering and TOC issues. Fix this
by realigning all nested bullets to use exactly two spaces per indentation level
consistently throughout the list to ensure proper Markdown rendering and TOC
generation.
akshatnema
deleted the
update-community-docs-e1240dc1f3bac0b4bb738c57637b848bbbe5646b
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation