docs(community): update latest community documentation #4245
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
quetzalliwrites and
sambhavgupta0705
as code owners
❌ Deploy Preview for asyncapi-website failed.
|
WalkthroughThis update introduces a large set of new and expanded community documentation files, guides, governance documents, mentorship program materials, onboarding resources, and configuration updates for AsyncAPI. It covers governance, contribution, mentorship, meetings, marketing, and onboarding, with new guides, charters, policies, and placeholder documents for ongoing work. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Docs
participant Maintainer
participant TSC
participant Community
Contributor->>Docs: Reads onboarding/contribution/governance guides
Contributor->>Maintainer: Submits PR or issue
Maintainer->>TSC: Reviews, escalates for governance or voting if needed
TSC->>Community: Publishes decisions, updates docs
Community->>Contributor: Provides feedback, support, mentorship
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
asyncapi-bot
requested review from
Aahil13,
VaishnaviNandakumar,
ashmitjsg and
vishvamsinh28
Markdown Check ResultsWe found issues in the following markdown files: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4245 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
🔭 Outside diff range comments (3)
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
28-35: Root-relative links resolve to 404While the conventional-commits URL was fixed, the two git-workflow links still use
/asyncapi/community/..., which becomeshttps://www.asyncapi.com/asyncapi/...and breaks. Replace them with the full GitHub URL or a correct site-relative docs link.config/edit-page-config.json (1)
15-37: New community entries are shadowed by the fallback matcher
"value": ""(lines 15-17) is the catch-all rule and is evaluated before the newly-added community paths that start at line 31.
Because it matches every path, none of the new rules will ever be reached, so edit links for the new docs will still point toasyncapi/websiteinstead ofasyncapi/community.Move the empty-string fallback to the very end of the array (or insert the new rules above it) to make the additions effective.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)
15-33: Unresolved merge-conflict markers presentThe
=======separator indicates a leftover merge conflict; both versions of the ideas table are currently in the file. Remove the markers and keep only the intended content to avoid duplicated or inconsistent information.
🧹 Nitpick comments (84)
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (1)
47-47: Restore trailing newline for POSIX complianceRemoving the final newline can trip some linters and causes noisy diffs later. It’s safer to keep the terminating newline.
markdown/docs/community/000-onboarding/how-to-contribute.md (1)
1-3: Placeholder wording is fine, but set an explicit TODOConsider adding an explicit follow-up task (
TODO:or GitHub issue link) so the document does not get forgotten once the PR merges.config/edit-page-config.json (1)
31-64: Keep entries alphabetically (or logically) groupedOnce the order issue above is fixed, consider grouping the new
community/*prefixes alphabetically. This eases future maintenance of the config file.markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (3)
1-3: Spelling/typos in the intro
- “annoucement” → “announcement”
- Optional: drop “Status:” prefix and rely on badge/label for consistency with other program READMEs.
11-18: Ordinal numbers are incorrectUse “23 January” or “23rd January” instead of “23th January” (same for other dates).
Minor, but polish helps when external organisations read the timeline.
6-8: Escaping in Markdown links not requiredThe back-slashes before the closing parentheses produce a trailing “)” in the rendered output:
[@acethecreator](…)\): …Remove the back-slashes; plain
)(:is valid.markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (2)
7-13: Heading level jump violates MD001The file has
#followed directly by###. Change “### Contact information” (and following sections) to##to keep heading increments sequential.
29-33: Minor formatting & wording
- “Contact Number(include…” → “Contact number (include country code)”
- Extra spaces before some bullet points break list indentation in some renderers.
Not critical, but quick clean-ups improve readability.
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (4)
10-10: Possible typo in Twitter handle
https://twitter.com/derberqlooks miss-spelled. Lukasz Gornicki usually usesderberg.
3-7: Second H1 breaks heading hierarchy
The document starts with# Status: Completedand immediately adds another# Season of Docs. Markdown-lint (MD001) prefers a single top-level heading. Consider downgrading the second one to##.
21-24: Bullet uses hyphen where an en-dash is expected
“September - October” is flagged by LanguageTool. Using “September – October” improves typographic quality.
30-34: Table row mis-aligned
The TOTAL row has only two pipes instead of three, which renders badly in some markdown engines. Ensure each row has the same number of separators.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (2)
9-9: Missing space
“18weeks” → “18 weeks”.
12-22: Blank lines required around the table
markdownlint (MD058) warns that tables should be preceded and followed by blank lines for consistent rendering.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (2)
3-7: Heading increments jump from H1 to H3
MD001 flags this. Change “## Timeline” to##(it already is) and ensure the previous heading isn’t H1 repeated elsewhere.
14-26: Table needs surrounding blank lines & strike-through syntax
- Add blank lines before and after the table (MD058).
- Using raw
<del>tags inside a pipe table often breaks rendering; prefer Markdown strike-through~~…~~.markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (2)
3-5: Heading level jumps from H1 to H5
##### Introductionshould be## Introductionto keep incremental order.
11-15: Long multi-idea bullet could be split
The first bullet packs multiple expectations into a single sentence; splitting into separate bullets improves readability for mentors skimming responsibilities.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md (1)
12-24: Add blank lines around the table
Same MD058 warning as other mentorship files—surround the table with blank lines so it renders correctly on the site.markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
31-32: Add descriptive alt-text for the screenshot to meet accessibility guidelinesThe embedded image lacks an
altdescription. Screen-reader users will miss the instruction, violating WCAG A/AA requirements that AsyncAPI docs generally follow.
Add a short alt-text such as “GitHub global workflow trigger button highlighted”.markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (1)
8-12: Numbered list renders as repeated “1.” due to missing blank lineBecause there is no blank line before the list, GitHub Markdown auto-numbers every item as “1.”.
Insert a blank line before the list or use proper ordered-list syntax to avoid visual confusion for contributors following these steps.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (4)
1-2: Typo: “Projects ideas” → “Project ideas”Minor grammar nit.
12-13: Spelling error in description“React templating engile” → “React templating engine”.
14-16: Run-on sentence makes the Glee documentation idea hard to parseConsider splitting into two sentences and inserting missing space before “and how to deploy Glee.” for readability.
27-27: Inconsistent term “visualiser” vs. “visualizer”Stick to a single variant (AsyncAPI docs typically use US English “visualizer”) to avoid searchability issues.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (4)
1-2: Same title typo as 2023 list“Projects ideas” → “Project ideas”.
4-6: Heading level skips (MD001)
### Ideas listshould be## Ideas listto increment by one level from the H1 above.
17-17: Spelling & confidence phrasing“I think we should standardize this” → “We should standardize this”. Also correct “prodution-ready” later in the file.
24-25: Typo “Fuction-as-a-Service” and wording “issue in difficulty”Replace with “Function-as-a-Service (FaaS)” and drop the “in difficulty” phrase for conciseness.
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (1)
7-14: Tighten wording of the contribution-types listA few bullets read awkwardly (“Answer to questions…”, “You come up with the idea that we used to do something great…”). Suggest re-phrasing for clarity, e.g. “Answer questions in issues or on Slack”, “Share feedback (ideas that led to improvements) via Slack or other channels”.
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (1)
33-33: Fix typo in ‘Maintenance’The project title in row 7 spells “Maintainance”. Correcting to “Maintenance” avoids search/indexing issues and keeps the table professional.
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)
58-65: Typo and punctuation in Conference-website idea
- “Maintainance” → “Maintenance”.
- Consider commas between mentor handles for readability.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
43-44: Mixed list marker style
*is used once inside a numbered context where the rest of the document uses-/numbers, triggeringMD004. Use a consistent list marker to keep lint clean.markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (4)
16-18: Plural noun agreement (“consists”)“The spec changes lifecycle consist of 2 parts” → “consists” to match the singular subject.
23-24: Grammar + subject/verb agreement“contributors/maintainers reviews” should be “contributors/maintainers review” (plural verb).
49-49: Colloquial phrase weakens formal doc tone“the world of open source won again” is informal and ambiguous. Consider re-phrasing to a clearer, neutral statement such as “the release is announced to the wider open-source community.”
65-65: Typo: “preperation”Should be “preparation.”
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (4)
5-5: Heading-level jump (MD001)
### First projectskips the expected##level after the H1. Promote to##(or demote the H1) for consistent hierarchy.
12-12: Misspelling: “Specifing”Replace with “Specifying.”
21-22: Clarity & punctuation“Add a protocol-specific, additional info” → “Add protocol-specific information” (drop the article and extra comma).
29-30: Double space + wording“A learning experience” has double spacing and reads awkwardly. Consider “a learning experience that is useful, fun and interactive.”
markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
29-29: Inconsistent capitalisation in list“Be community-oriented” starts with lowercase “community.” Align with the other bullets: “Be Community-oriented”.
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (2)
70-80: Duplicate outcome textLines 70-71 and 79-80 repeat the same outcome sentence for different projects. Adjust the second occurrence to describe the redesign project’s specific success criteria (e.g., “Deliver a responsive dark-theme design consistent with new visual guidelines”).
44-44: Compound adjective needs hyphen“Open Source Contribution” → “Open-source contribution” when used as a compound adjective.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (2)
5-7: Heading-level increment error (MD001)
### Ideas listshould be## Ideas listto follow the H1.
13-13: Misspelling: “EDAVisualiser”The correct project name is “EDAVisualizer” (with a ‘z’). Check consistency throughout the document.
markdown/docs/community/050-mentorship-program/summerofcode/README.md (2)
3-4: Normalize heading hierarchyJumping from H1 (
#) directly to H6 (###### Introduction) and then to H3 (### Requirement) violates MD001 and hurts readability.
Use sequential levels (e.g.,## Introduction,## Requirements).Also applies to: 10-12
36-37: Add protocol to bare domain
[AsyncAPI website](asyncapi.com)renders as a relative link.
Preferhttps://asyncapi.comto avoid broken navigation.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (3)
13-14: Fix typo “Specifing” → “Specifying”Minor spelling error in the bullet “Specifing dynamic parts of channel name”.
26-27: Remove double-space before “learning”Extra space after “a” in “create a learning experience”.
47-49: Use an en-dash for date range
September - October→September–Octoberfor typographic correctness.markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (1)
32-33: Incorrect back-tick notationThe phrase “Use backticks (``) for code” shows two consecutive back-ticks; Markdown denotes inline code with a single back-tick.
Consider replacing with “`code`”.markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1)
5-6: Grammar: missing comma after “responds to”Sentence should read: “committee that responds to, investigates, and resolves …”.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (3)
45-47: Spelling: “requried” → “required”Correct the heading “Technical skills requried”.
57-58: Spelling: “checkes” → “checks”In bullet describing the GitHub Action: “and checkes if voters file was edited”.
60-60: Add period to “etc.”American English convention: “etc.” includes a terminating period.
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (4)
22-32: Clarify the “4 contributions per year” ruleSpecify whether the count is based on a calendar year or a rolling 12-month window so that ambassadors know exactly when their activity will be evaluated.
39-44: Fix heading grammarRename “Ambassadors duties” → “Ambassador duties” to keep the singular noun–singular noun pattern used in other headings and avoid grammatical friction.
48-53: Tighten wording of the last benefitThe bullet “All our respects for your contribution!” is informal and overlaps with “Community-wide recognition.” Consider removing it or rephrasing as “Public acknowledgment of your contributions.”
56-57: Drop the weak intensifier“very simple” is filler; “The process is simple.” conveys the same message more crisply.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (2)
34-41: Make placeholders explicitThe snippet shows
git clone URL, which readers may copy verbatim. ReplaceURLwith<repository-url>(or similar angle-bracket notation) to signal a placeholder.
98-101: Branch-tracking step assumes the branch is checked out
git branch -u upstream/master masterworks only whenmasteris the current branch. A safer pattern is:git checkout master git branch --set-upstream-to=upstream/masterConsider updating to avoid surprising errors.
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (2)
42-67: Label table has duplicatesBoth
docsandarea/docs(and similarlydesignvsarea/design) appear, which may confuse newcomers. Either merge them or add a brief note explaining the difference between general and area-prefixed labels.
79-80: Tone: cut back on exclamation marksOne exclamation mark is enough; multiple can feel shouty in documentation aimed at professionals.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (1)
23-28: Table style trips MD055Trailing
|characters violate markdown-lint rules and are unnecessary for GitHub rendering. Removing them will keep the table intact and silence the linter.markdown/docs/community/COC-incident-resolution-procedures.md (1)
228-234: Spelling: use “cannot” instead of “can not”Line 232 reads “can not”; the standard form is “cannot.”
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (6)
14-18: Sentence is overly long and hard to parseThe paragraph crams multiple ideas (weekly workflow, Slack notifications, manual trigger, etc.) into a single sentence. Consider splitting it into two-three concise sentences to aid readability.
16-17: Plural.asyncapi-toolfiles: clarify wording & directory freedomThe guidance is correct but the phrasing is clunky (“In case, you need… same case applies for monorepo as well”). Re-phrase for clarity and remove the stray comma after “In case”.
70-70: Minor spelling (behaviour → behavior) & consistencyThe docs elsewhere use U.S. spelling (“behavior”). Stick to one variant throughout the guide.
72-74: Repetition & passive voiceThe fragment “according to your need” is repeated twice. Suggest dropping the duplication and using active voice to improve flow.
124-125: Typo: “Moreoever” → “Moreover”Straightforward spelling fix.
74-74: Grammar: “doesn't matches”Should be “doesn't match”.
markdown/docs/community/020-governance-and-policies/voting.md (2)
12-15: Word repetition & styleThree consecutive sentences start with “Voting”. Consider re-phrasing the second sentence to avoid the repetition flagged by markdown-lint.
35-38: Markdown-lint: nested list indentationThe sub-bullets under “GB members will review the request” are indented with a single space; markdown-lint (MD007) expects two. Adjust indentation to keep rendering consistent across viewers.
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (2)
18-25: Capitalization & formatting“json pointers” → “JSON Pointers” for spec-terminology correctness.
30-33: Typo: “publishes too”Should be “publishes to”.
markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md (1)
28-30: Missing fenced-code language identifiermarkdown-lint (MD040) points out that the code block lacks a language tag. Add
mdorbashafter the triple backticks for proper syntax highlighting.markdown/docs/community/styleguide/version-control.md (1)
94-94: Double spaceExtra space between “shown in” — remove redundant spacing for consistency.
markdown/docs/community/020-governance-and-policies/donating-projects.md (2)
13-15: Pluralize section title for accuracyThe heading should read “Legal Considerations” (plural) to match the two separate items that follow.
40-41: Missing space after inline code block
@fmvilascan →@fmvilascan. The missing space renders the two words as one in HTML output.markdown/docs/community/onboarding-guide/github-actions.md (2)
58-60: Inconsistent bullet marker style (MD004)Earlier lists in the document use hyphens (
-) while these two lists switch to asterisks (*). Pick one style for the whole file to avoid markdown-lint warnings.Also applies to: 70-72
95-103: Use proper headings instead of bold text (MD036)
**Opt-in**and**Opt-out**are visually headings but semantically plain text. Convert them to#### Opt-in/#### Opt-out(or the appropriate level) so they appear in the TOC and keep the heading hierarchy intact.markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (1)
7-8: Wordiness: “in a transparent manner”Consider trimming to “transparently” for tighter prose: “ensuring the group works efficiently and transparently.”
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (1)
72-75: Typo: “Progam Administrators”Line 74 contains “Progam”. Should be “Program”.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (60)
config/edit-page-config.json(1 hunks)markdown/docs/community/000-onboarding/docs-onboarding-checklist.md(1 hunks)markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md(1 hunks)markdown/docs/community/000-onboarding/how-to-contribute.md(1 hunks)markdown/docs/community/000-onboarding/where-to-contribute.md(1 hunks)markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md(1 hunks)markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md(1 hunks)markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md(1 hunks)markdown/docs/community/010-contribution-guidelines/contribution-flow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/git-workflow.md(1 hunks)markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognize-contributors.md(1 hunks)markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md(1 hunks)markdown/docs/community/011-styleguide/grammar.md(1 hunks)markdown/docs/community/011-styleguide/numbers.md(1 hunks)markdown/docs/community/020-governance-and-policies/CHARTER.md(1 hunks)markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md(1 hunks)markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md(1 hunks)markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md(1 hunks)markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md(1 hunks)markdown/docs/community/020-governance-and-policies/donating-projects.md(1 hunks)markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md(1 hunks)markdown/docs/community/020-governance-and-policies/voting.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md(1 hunks)markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md(1 hunks)markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md(1 hunks)markdown/docs/community/040-guides/keep-repository-settings-consistent.md(1 hunks)markdown/docs/community/050-mentorship-program/README.md(1 hunks)markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/README.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/application-template.md(1 hunks)markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md(1 hunks)markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md(1 hunks)markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)markdown/docs/community/060-meetings-and-communication/slack-etiquette.md(1 hunks)markdown/docs/community/070-marketing/social-media-communication-guidelines.md(1 hunks)markdown/docs/community/COC-incident-resolution-procedures.md(1 hunks)markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md(1 hunks)markdown/docs/community/community-glossary.md(1 hunks)markdown/docs/community/onboarding-guide/github-actions.md(1 hunks)markdown/docs/community/onboarding-guide/identifying-good-first-issues.md(1 hunks)markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md(1 hunks)markdown/docs/community/styleguide/version-control.md(1 hunks)
🧰 Additional context used
🧠 Learnings (18)
📓 Common learnings
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-editlinks.js:58-59
Timestamp: 2025-01-08T15:15:00.759Z
Learning: In the AsyncAPI codebase, batch processing operations (like in the Dashboard script and check-editlinks.js) follow a sequential pattern using await in loops, which is the preferred approach for maintaining consistency across the codebase.
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3301
File: scripts/markdown/check-markdown.js:0-0
Timestamp: 2024-10-18T17:24:45.053Z
Learning: In `scripts/markdown/check-markdown.js`, the script is not run in an asynchronous environment, so refactoring it to use `async/await` is unnecessary.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (5)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: asyncapi/website#3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (3)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (3)
Learnt from: iambami
PR: asyncapi/website#4111
File: markdown/blog/community-spotlight-aayush.md:3-3
Timestamp: 2025-06-03T06:48:09.304Z
Learning: For AsyncAPI community spotlight blog posts, the frontmatter date should reflect the actual publication date, not the month being highlighted in the spotlight. For example, a "May Community Spotlight" can be published in June with a June date in the frontmatter.
Learnt from: Siddhant-Pragyan-Sinha
PR: asyncapi/website#4074
File: markdown/blog/open-nest.md:11-12
Timestamp: 2025-04-28T01:13:59.084Z
Learning: For AsyncAPI blog posts, author photo filenames don't necessarily need to match the author's official name, as some authors may use pen names or nicknames (e.g., Aishat Muibudeen using "maya_picture.webp" for her avatar).
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
config/edit-page-config.json (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/markdown/check-edit-links.test.js:20-46
Timestamp: 2025-01-14T14:58:38.076Z
Learning: In the AsyncAPI website codebase, the edit-page-config.json contains a fallback match entry that ensures determineEditLink function always has a valid target.value, making null checks unnecessary.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-edit-links.js:83-88
Timestamp: 2025-01-14T15:12:29.840Z
Learning: In the AsyncAPI website's edit link generation logic, the `editUrls` configuration (config/edit-page-config.json) includes a fallback entry with an empty value that acts as a catch-all matcher. Therefore, `editOptions.find()` will always return a match, making null checks on the result unnecessary and untestable.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-editlinks.js:80-93
Timestamp: 2025-01-14T09:23:32.728Z
Learning: In the AsyncAPI website's edit link generation system, the `editOptions` array in `edit-page-config.json` includes a fallback entry with an empty string value (`''`) that matches any URL path, ensuring that `determineEditLink()` function always finds a target and never returns null.
markdown/docs/community/010-contribution-guidelines/git-workflow.md (2)
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (2)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: TRohit20
PR: asyncapi/website#4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
markdown/docs/community/styleguide/version-control.md (1)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (1)
Learnt from: aminoxix
PR: asyncapi/website#4127
File: components/layout/CommunityLayout.tsx:179-179
Timestamp: 2025-06-10T06:27:25.419Z
Learning: In AsyncAPI's community data structure, ambassadors and TSC members are guaranteed to have GitHub accounts. The `github` field is required in both `Ambassador` and `Tsc` interfaces, and the data processing in `addAdditionalUserInfo()` converts GitHub usernames to full URLs, ensuring safe string operations when extracting usernames from URLs.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (2)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
Learnt from: aminoxix
PR: asyncapi/website#4127
File: components/layout/CommunityLayout.tsx:179-179
Timestamp: 2025-06-10T06:27:25.419Z
Learning: In AsyncAPI's community data structure, ambassadors and TSC members are guaranteed to have GitHub accounts. The `github` field is required in both `Ambassador` and `Tsc` interfaces, and the data processing in `addAdditionalUserInfo()` converts GitHub usernames to full URLs, ensuring safe string operations when extracting usernames from URLs.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (4)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: anshgoyalevil
PR: asyncapi/website#3950
File: scripts/utils/check-locales.ts:122-129
Timestamp: 2025-04-20T16:05:16.482Z
Learning: In the AsyncAPI website project, Next.js throws errors at runtime when locale files are missing, making additional validation for missing files unnecessary in the check-locales script.
Learnt from: akshatnema
PR: asyncapi/website#3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., `require('../scripts/build-rss.ts')`). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.
Learnt from: akshatnema
PR: asyncapi/website#3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the `tests/fixtures/tools/automated-tools.json` file, the `language` field within the `filters` object can be either a string or an array. Both formats are acceptable and supported in the codebase.
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (4)
Learnt from: TRohit20
PR: asyncapi/website#4107
File: markdown/docs/tools/studio/architecture.md:23-23
Timestamp: 2025-05-09T17:35:57.171Z
Learning: In the AsyncAPI Studio architecture documentation, "Layer Breakdown" is intentionally structured as an H3 heading (subsection) because it provides additional detail about the layered architecture pattern introduced earlier, rather than being a standalone main section.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
markdown/docs/community/onboarding-guide/github-actions.md (5)
Learnt from: akshatnema
PR: asyncapi/website#3168
File: jest.config.js:6-6
Timestamp: 2024-10-15T17:44:59.227Z
Learning: In this repository, the `coverage` directory is added to `.gitignore`, and coverage reports are generated during GitHub Actions runs.
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: .github/workflows/check-edit-links.yml:25-29
Timestamp: 2025-01-08T15:16:27.655Z
Learning: In GitHub workflows running scripts with process.exit statements for error handling (like check-editlinks.js in asyncapi/website), avoid adding error suppression (|| true) at the workflow level as it would mask the intended error reporting mechanism.
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: .github/workflows/check-edit-links.yml:30-37
Timestamp: 2025-01-14T14:57:08.491Z
Learning: In GitHub Actions workflows, avoid using {...} blocks for output redirection. Instead, use individual redirects with proper quoting as recommended by GitHub Docs. For example:
```yaml
echo "key<<EOF" >> "${GITHUB_OUTPUT}"
echo "${value}" >> "${GITHUB_OUTPUT}"
echo "EOF" >> "${GITHUB_OUTPUT}"
```
🪛 LanguageTool
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...google.github.io/gsocguides/mentor/) - [Open Source Best Practices](https://opensource.guid...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/summerofcode/README.md
[style] ~5-~5: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ... contribute to open-source projects and improve their coding skills. If you want to dev...
(IMPROVE_STRENGTHEN)
[style] ~43-~43: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3630 characters long)
Context: ...I for your Google Summer of Code project!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
[style] ~9-~9: Consider using a synonym to be more concise.
Context: ...//github.com/AceTheCreator) | There are a lot of places where components need to be crea...
(A_LOT_OF)
[style] ~14-~14: To elevate your writing, try using a synonym here.
Context: ...ithub.com/KhudaDad414)|Currently, it is hard to get started with Glee as a new user,...
(HARD_TO)
[style] ~27-~27: Consider using a different adjective in this context to strengthen your wording.
Context: ...t it only works in read-only mode. So a good solution would be to add the ability to...
(GOOD_ALTERNATIVE)
[uncategorized] ~27-~27: Do not mix variants of the same word (‘visualizer’ and ‘visualiser’) within a single text.
Context: ...d, similar to the current blocks in the visualizer. 21 | [Desktop/Native application for A...
(EN_WORD_COHERENCY)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
[style] ~13-~13: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ...ructive feedback, and help contributors improve their coding skills. - Please also enc...
(IMPROVE_STRENGTHEN)
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md
[grammar] ~2-~2: Ensure spelling is correct
Context: ...us: In Progress > Program participation annoucement can be found here https://github.com/or...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md
[uncategorized] ~49-~49: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e notes are published, and the world of open source won again. Learn more about the [relea...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
[grammar] ~13-~13: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...other product designers looking to make open source contributions or to maybe gain experien...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~27-~27: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
[style] ~11-~11: Consider replacing this word to strengthen your wording.
Context: ...ull requests. You are a language expert and can review docs or an expert in a speci...
(AND_THAT)
[style] ~15-~15: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: ...ues or in Slack You can help us out in many different ways. Just check out [this](https://allcontr...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~17-~17: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... if we failed in recognizing your work. Feel free to contact us on [slack](https://asyncapi....
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md
[style] ~79-~79: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4218 characters long)
Context: ...d let's build something awesome together!
(EN_EXCESSIVE_EXCLAMATION)
markdown/docs/community/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/asyncapi-mentorship/2022/project-ideas.md
[style] ~17-~17: Phrases like “ I think we” can make your message sound insecure. Consider making your writing sound more confident and self-assured.
Context: ...hrow exceptions from the main function. I think we should standardize this and propose a system b...
(I_THINK_WE_SHOULD)
[style] ~20-~20: Consider using a synonym to be more concise.
Context: ...y and we use GitHub Actions to automate lots of things in the organization. GitHub acti...
(A_LOT_OF)
[style] ~22-~22: Consider a different adjective to strengthen your wording.
Context: ...ub.com/asyncapi/cli) | @fmvilas | We're doing a great job at Glee and Generator and it's about th...
(DO_A_GREAT_JOB)
[grammar] ~24-~24: Ensure spelling is correct
Context: ...eople and companies doing serverless or Fuction-as-a-Service (FaaS). Making Glee integr...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~25-~25: ‘in difficulty’ might be wordy. Consider a shorter alternative.
Context: ... is probably the most complicated issue in difficulty. If we want people to adopt Glee in pro...
(EN_WORDINESS_PREMIUM_IN_DIFFICULTY)
[grammar] ~25-~25: Ensure spelling is correct
Context: ...dopt Glee in production, it needs to be prodution-ready, and that means being able to han...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/README.md
[style] ~3-~3: Consider using a more concise synonym.
Context: ...The AsyncAPI Initiative participates in a variety of mentoring programs. AsyncAPI is a great...
(A_VARIETY_OF)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
[style] ~44-~44: Consider using an alternative to strengthen your wording.
Context: ...at might get involved. (At AsyncAPI, we want to work with any TW, regardless of thei...
(WANT_KEEN)
[style] ~44-~44: Consider using a different adverb to strengthen your wording.
Context: ...look forward to mentoring TW(s) who are completely new to tech and making them feel welcom...
(COMPLETELY_ENTIRELY)
[typographical] ~49-~49: Consider using an en dash here instead of a hyphen.
Context: ... for the issues assigned/selected. - September - October: We determine if we can comple...
(QB_NEW_EN_DASH_RULE_EN)
[style] ~54-~54: Consider using “350” only; there is no need for the currency symbol because ‘dollars’ follows.
Context: ...ould also like to request an additional $350 dollars in our budget to provide cool s...
(REPEATED_CURRENCY)
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md
[grammar] ~58-~58: Ensure spelling is correct
Context: ...** 175 Hours ## 7) Conference Website Maintainance Ensure our conference website remains a ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...at server to interact with the app. - Adding servers security - Add security detai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md
[style] ~2-~2: It’s more common nowadays to write this noun as one word.
Context: ...nsible for updating the document. --> | name | [chore: introduce govern...
(RECOMMENDED_COMPOUNDS)
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md
[style] ~37-~37: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...come ambassadors for the whole year. 3. If you were accepted as ambassador on the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~41-~41: ‘in tune with’ might be wordy. Consider a shorter alternative.
Context: ... 2022. ### Ambassadors duties - Be in tune with AsyncAPI's mission and values. - Always...
(EN_WORDINESS_PREMIUM_IN_TUNE_WITH)
[style] ~56-~56: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...he process of becoming an ambassador is very simple. Go to the community repository and...
(EN_WEAK_ADJECTIVE)
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md
[style] ~75-~75: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uld be explicitly stated in the Scope. In case two Bounty Issues are inextricably...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~77-~77: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ust be explicitly stated in the Scope. In case the total reward for all submitted...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~124-~124: Consider simply using “of” instead.
Context: ...nty Issue (on Monday, the last activity of any of the abovementioned types was four or mo...
(OF_ANY_OF)
[style] ~147-~147: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... Issue Timeline extension should happen prior to any current milestone of the Bounty Iss...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~173-~173: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ered the one that reached End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~175-~175: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the one that reached the End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~177-~177: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ered the one that reached End Of Life. In case a Bounty Issue gets an assignee be...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~182-~182: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ssue Candidate. A dropped Bounty Issue can not be assigned again to the same Bounty Pr...
(CAN_NOT_PREMIUM)
[style] ~195-~195: The phrase “taken into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...solution of the Bounty Issue, etc.) are taken into consideration only if they occurred after the additio...
(TAKE_INTO_CONSIDERATION)
[uncategorized] ~216-~216: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...elies on Open Collective's Fiscal Host 'Open Source Collective' to service payments and, th...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~216-~216: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...er they will be able to receive payment prior to starting participation in the Bounty Pr...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~216-~216: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...*. AsyncAPI will not take any action if Open Source Collective refuses to relay the payment...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
[style] ~40-~40: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...e to projects under AsyncAPI Initiative on a regular basis, and we'll welcome them as new maintain...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
[style] ~107-~107: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...r=blue" width=300 /> ### Contact Feel free to contact us if you need more explanation...
(FEEL_FREE_TO_STYLE_ME)
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md
[grammar] ~45-~45: Ensure spelling is correct
Context: ...mitment**: 175 Hour Technical skills requried Typescript, nodejs, websocket, EDA b...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~57-~57: Ensure spelling is correct
Context: ...n that reacts on any push to master and checkes if voters file was edited. Then reads i...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~60-~60: In American English, abbreviations like “etc.” require a period.
Context: ...rs (social accounts, hire availability, etc) Learn more here https://github.com/as...
(ETC_PERIOD)
[style] ~141-~141: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...important, that endpoint should be done in a similar way as in our main CLI - https://github.com...
(IN_A_X_MANNER)
markdown/docs/community/020-governance-and-policies/voting.md
[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...b.com/asyncapi/community) repository. - Voting automation works only with GitHub Issue...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~14-~14: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... Pull Requests. The Discussions should only be used for initial discussion, brainst...
(ONLY_EXCLUSIVELY_STYLE)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[style] ~168-~168: Try using a synonym here to strengthen your writing.
Context: ...proved, contact Fran Mendez so he can give you access to all required tools. ## How...
(GIVE_PROVIDE)
[grammar] ~230-~230: Ensure spelling is correct
Context: ...Thank you.) . 8. A few moments later....Hurray! Your episode is now uploaded successful...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
[style] ~58-~58: Consider using an alternative to strengthen your wording.
Context: ... - when an existing open-source project wants to join the AsyncAPI umbrella (owner wa...
(WANT_KEEN)
[grammar] ~66-~66: Ensure spelling is correct
Context: ...a discussion or vote, you can use three emojies: * 👍 (vote for) * 👎 (vote against) * ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md
[style] ~7-~7: Consider replacing this phrase with the adverb “transparently” to avoid wordiness.
Context: ...s have a voice and that the group works in a transparent manner. Multiple chairpersons can be elected i...
(IN_A_X_MANNER)
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md
[grammar] ~125-~125: Ensure spelling is correct
Context: ...ter/scripts/tools/categorylist.ts) from where you can opt the best category for your ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~125-~125: Ensure spelling is correct
Context: ...n opt the best category for your tools. Moreoever, if you don't find any, you can send us...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md
[uncategorized] ~44-~44: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ensions, Spectral Linting, Testing, and Open Source Contribution. - 🧩 Difficulty: Medi...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~80-~80: Ensure spelling is correct
Context: ...Required:** Typescript, Node js, Figma, TailwindCSS - 🧩 Difficulty: Medium/Hard - 👩🏿...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/onboarding-guide/github-actions.md
[style] ~99-~99: Consider a more expressive alternative.
Context: ...r to trigger it manually for you. To do this, reach out on Slack or open an iss...
(DO_ACHIEVE)
markdown/docs/community/020-governance-and-policies/donating-projects.md
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...r both maintainers and contributors. - We make Intellectual Property (IP) Review ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md
[style] ~28-~28: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...manent action shall require approval of a majority of non-conflicted members of the CoC Commi...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~28-~28: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...ee may take action without a meeting if a majority of non-conflicted members express agreemen...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
[uncategorized] ~50-~50: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ors can connect and collaborate.
- Open Source Contributions: Encourage contributions ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~51-~51: Ensure spelling is correct
Context: ...platforms like Slack, GitHub, LinkedIn, Mastadon, YouTube, and Twitter to facilitate dis...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~81-~81: Ensure spelling is correct
Context: ... the community manager: - By adding neccessary information from the Marketing Working ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~84-~84: Ensure spelling is correct
Context: ...cipation - Publish marketing blog every quater detailing the activity and update of th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~115-~115: Ensure spelling is correct
Context: ...ry major post on Twitter, LinkedIn, and Mastadon will link back to the website. - Encour...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
[grammar] ~74-~74: Ensure spelling is correct
Context: ... In that case, AsyncAPI may require the Progam Administrators to designate a replacement Mentor and r...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~94-~94: Ensure spelling is correct
Context: ...iewed by the selected project Mentor to which they were submitted. A Mentor may accep...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[uncategorized] ~106-~106: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...licly accessible location and under an [Open Source Initiative approved license](http://www...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
[typographical] ~23-~23: Consider using an en dash here instead of a hyphen.
Context: ...or their issues assigned/selected. - September - October: We determined if we could com...
(QB_NEW_EN_DASH_RULE_EN)
markdown/docs/community/020-governance-and-policies/CHARTER.md
[style] ~36-~36: Consider a more concise word here.
Context: ...ze of TSC. The size is expected to vary in order to ensure adequate coverage of important a...
(IN_ORDER_TO_PREMIUM)
[style] ~67-~67: ‘a majority of the’ might be wordy. Consider a shorter alternative.
Context: ...can only be removed upon resignation or a majority of the TSC votes. Next steps will be specified...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF_THE)
[style] ~93-~93: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...rovided in Section 6, decisions require a majority of votes. 4. Decisions must always be made...
(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cribe the contribution, the alternative open source license(s), and the justification for u...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... justification for using an alternative open source license for the Project. License except...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~119-~119: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...ject to approval by the Series Manager. In the event that a Project-specific CoC has not been app...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
[style] ~120-~120: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...opted, on its web site at least 30 days prior to such policy taking effect; provided, ho...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~127-~127: Consider replacing this phrase with the adverb “professionally” to avoid wordiness.
Context: ... 1. Engage in the work of the Project in a professional manner consistent with maintaining a cohesive ...
(IN_A_X_MANNER)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/050-mentorship-program/summerofcode/README.md
7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
17-17: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h5
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
5-5: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md
28-28: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md
7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md
12-12: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
markdown/docs/community/COC-incident-resolution-procedures.md
12-12: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
12-12: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
13-13: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
13-13: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
14-14: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
15-15: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
15-15: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
16-16: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 4; Actual: 3
(MD007, ul-indent)
21-21: Hard tabs
Column: 3
(MD010, no-hard-tabs)
22-22: Inconsistent indentation for list items at the same level
Expected: 3; Actual: 2
(MD005, list-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
22-22: Hard tabs
Column: 1
(MD010, no-hard-tabs)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
4-4: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
17-17: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/050-mentorship-program/README.md
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
5-5: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md
5-5: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md
24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
37-37: Table column count
Expected: 4; Actual: 3; Too few cells, row will be missing data
(MD056, table-column-count)
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md
24-24: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
25-25: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
26-26: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
27-27: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
28-28: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
32-32: Images should have alternate text (alt text)
(MD045, no-alt-text)
103-103: Images should have alternate text (alt text)
(MD045, no-alt-text)
108-108: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/020-governance-and-policies/voting.md
35-35: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
83-83: Bare URL used
(MD034, no-bare-urls)
markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md
28-28: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md
28-28: Table pipe style
Expected: trailing_only; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
43-43: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
markdown/docs/community/onboarding-guide/github-actions.md
58-58: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
59-59: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
60-60: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
70-70: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
71-71: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
72-72: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
101-101: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md
4-4: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
11-11: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
16-16: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
66-66: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
67-67: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
74-74: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
81-81: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
82-82: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
83-83: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
132-132: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
138-138: Headings must start at the beginning of the line
(MD023, heading-start-left)
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
5-5: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
5-5: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
🔇 Additional comments (29)
markdown/docs/community/011-styleguide/numbers.md (1)
159-159: Formatting fix looks goodThe leading-space removal brings this list item in line with the others.
markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md (1)
1-3: Add Hugo front-matter so the page rendersPages under
markdown/docsneed a front-matter header (--- title: … weight: … ---). Without it, the build may skip or warn on this file.markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (1)
99-101: Bullet list formatting looks goodRemoving the stray hyphen keeps the list style consistent with the two previous bullets. No further action needed.
markdown/docs/community/011-styleguide/grammar.md (1)
75-76: Consistent bullet styling maintainedNice catch removing the leading hyphen; the list is now uniformly formatted.
No additional issues spotted.markdown/docs/community/000-onboarding/how-to-contribute.md (1)
1-3: Missing front-matter may break buildMost community docs include the YAML block (
---,title,weight, …) that the website generator relies on for routing and sidebar ordering.
Add a minimal front-matter header even for placeholder pages to avoid build-time 404s.markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
15-17: Double-check relative links render correctly
../010-contribution-guidelines/technical-writer-contributor-responsibilitiesand
../010-contribution-guidelines/prerequisite-knowledgeomit the “.md” suffix.
The Markdown processor in this repo usually needs the suffix for correct link rewriting; otherwise the links resolve to directories and may 404 once published.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)
20-21: Duplicate GitHub handle
Row 7 lists the mentor and links the mentee cell to the sameibishalprofile, but the mentee is “Milan D Vijay”. Double-check the link.markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (1)
17-20: Clarify image-compression requirementStating “compress as much as possible” is vague; consider adding an approximate size guideline (e.g. “≤300 kB”) or linking to an AsyncAPI asset-optimization doc so contributors know when their images are “small enough”.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (1)
6-8: Markdown-lint MD058: surround tables with blank linesThe table is not preceded by a blank line, which violates the repo’s markdown-lint rules and breaks some renderers. Add a blank line before and after the table block.
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (1)
1-1: Generated file noted – no manual action requiredLooks correct; flagging only to acknowledge review.
markdown/docs/community/050-mentorship-program/README.md (1)
29-41: Statistics table has inconsistent column countsRows 34 and 37 contain only three cells, so the “Total (per year)” column shifts. Ensure every row contains four cells (add the missing total or a placeholder such as
—).markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
47-48: Verify link pathThe link points to
code_of_conduct/code-of-conduct-committee.md, while elsewhere the repository usesCODE_OF_CONDUCT_COMMITTEE.md. Please confirm the path to avoid a 404.markdown/docs/community/050-mentorship-program/summerofcode/README.md (1)
28-30: Verify hard-coded ideas-page linkThe link points to the 2024 ideas page on the
masterbranch. Confirm that’s intentional for a generic “Getting Started” guide; otherwise update to the current year or a stable permalink.markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
15-17: Verify the default branch nameThe guide refers to
master, but several AsyncAPI repositories have already moved tomain. Using the wrong branch name will break commands such asgit fetch upstream master. Please confirm and update consistently.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (1)
43-50: Heading level skips (MD001)
#### Changes to the Programjumps from##to####without an intermediate###. Adjust heading levels to increment by one level at a time.markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (3)
172-180: Re-phrase repetitive “In case …” sentences to improve readabilityLines 172-180 contain four consecutive sentences that all start with “In case …”.
This repetition makes the paragraph heavy to scan and slightly dilutes key ideas (assignment status vs. End-Of-Life labels). Re-ordering or merging these conditions, and introducing connective words (“If”, “When”, “Otherwise”) will make the rules easier to comprehend.[ suggest_nitpick ]
124-131: Timeline wording is ambiguous around the Monday 4-day checkThe clause:
“on Monday, the last activity … was four or more calendar days before”
creates a “Monday + four days” window that actually spans Thursday → Sunday, not four full days as usually interpreted. Consider spelling it out explicitly (“… no activity since the preceding Thursday 23:59 UTC …”) to avoid disputes.
[ request_verification ]
200-221: Minor legal wording nitpick – “cannot” instead of “can not”Line 218 uses “can not”; the conventional contraction in legal/financial text is “cannot”. Tiny, but in a document that sets formal program rules, consistency matters.
[ suggest_nitpick ]
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (2)
66-70: Typos: “emojies” → “emojis”The plural of emoji is emojis (or the unchanged emoji).
Fixing this avoids trivial distractions in an otherwise polished governance doc.[ suggest_nitpick ]
72-76: Mixed list markers break Markdown lintersLines 72-76 use
-while the rest of the doc uses*. Several internal MD rules (MD004) flag this.
Pick one bullet style across the file to keep automated formatting checks green.[ suggest_nitpick ]
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (4)
12-16: Duplicate introduction paragraphLines 12-16 repeat almost verbatim the paragraph directly above them.
Removing the duplicate will tighten the document and prevent SEO penalties for repeated text.[ raise_critical_issue ]
42-54: Table rows have missing cells – breaks renderRows 44-54 in the big “Aim / Solution / Description / Tactics” table have blank cells in the Solution column, causing GitHub-Flavored Markdown to mis-align the remainder of the row.
Add the missing|separators or an explicit placeholder (–) so the table renders correctly.[ request_verification ]
80-85: Spelling: “neccessary”, “quater”• Line 81: neccessary → necessary
• Line 84: quater → quarterRunning
markdownlintor a spell-checker before commit would catch these.[ suggest_nitpick ]
93-99: Brand typo: “Mastadon” → “Mastodon”The social platform is Mastodon. Correcting improves professional appearance.
[ suggest_nitpick ]
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)
45-58: Asset paths may break on the public websiteEmbedded images reference
../../assets/meetings/.... The docs site generator rewrites paths relative todocs/. Verify that the assets folder is copied to<site>/assets/meetings/; otherwise the screenshots will 404.[ request_verification ]
21-32: Step enumeration uses repeated “1.”Markdown ordered lists accept repeated
1.and auto-number, but screen readers and some linters flag it. Consider explicit1., 2., 3.for accessibility.[ suggest_optional_refactor ]
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (3)
37-56: Confirm that Mermaid diagrams are enabled in productionThe document embeds a Mermaid flowchart. The AsyncAPI website builds with Docusaurus; Mermaid support is opt-in. Please verify that
@docusaurus/theme-mermaid(or the remark-plugin) is active, otherwise the raw diagram source will display as plain text.[ request_verification ]
74-84: Conference acronym “AACoT” appears without decodingLine 77 references a rebrand of AACoT but never expands the acronym. Add the full name on first use to avoid confusion for new readers.
[ suggest_nitpick ]
120-126: Minor spacing & punctuation issues• Line 122 “Ambassadors” → Ambassadors’ (possessive)
• Missing space after the comma in line 126 (“Accessibility.”) Small fixes but they surface in proofreading.[ suggest_nitpick ]
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Missing front-matter block
Please add the standard front-matter (title, optional description, weight) so the glossary is picked up by the docs site once content is added.
🤖 Prompt for AI Agents
In markdown/docs/community/community-glossary.md at the beginning (lines 1 to
3), the file is missing the required front-matter block. Add a YAML front-matter
block at the top of the file including at least the `title` field, and
optionally `description` and `weight` fields, so the documentation site can
recognize and properly display this glossary page once content is added.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add front-matter and accessibility-friendly placeholder
The page lacks the front-matter block (---, title, description, etc.) used throughout the docs site. Without it, Hugo will render the page with default metadata or may exclude it from menus.
Additionally, consider replacing the emoji-only “🚧” with a short text alternative (e.g., “Under construction”) so screen-reader users get the message.
[ draft: true ] in the front-matter is the common pattern for unfinished pages.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md at
lines 1 to 3, add a front-matter block at the top of the file including keys
like `title`, `description`, and `draft: true` to ensure proper metadata and
site integration. Replace the emoji-only "🚧" placeholder with a short text
alternative such as "Under construction" to improve accessibility for
screen-reader users.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Missing front-matter; add draft flag
Same concern as the previous onboarding doc: include a standard front-matter header and mark the page as draft while content is in progress. This keeps the build clean and avoids surfacing half-finished pages in navigation.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/where-to-contribute.md at the
beginning of the file (lines 1 to 3), add a standard front-matter block with a
draft flag to indicate the document is under construction. This front-matter
should include metadata such as title and draft: true to prevent the page from
appearing in navigation and keep the build clean while the content is
incomplete.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Placeholder needs metadata and accessibility tweak
Please add the usual front-matter block and set draft: true. Replace or complement the “🚧” emoji with accessible text so assistive technologies convey the status clearly.
🤖 Prompt for AI Agents
In
markdown/docs/community/070-marketing/social-media-communication-guidelines.md
at lines 1 to 3, add the standard front-matter block at the top of the file
including the key `draft: true` to mark the document as a draft. Replace the
"🚧" emoji with descriptive accessible text or add an aria-label or similar
accessible markup so screen readers can clearly convey the document's
under-construction status.
| Leave only the **Allow squash merging** option selected. This option combines all commits into one before merging the changes into the `master` branch. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use “main” rather than “master” to match modern default branches
AsyncAPI repos have been gradually moving to the main convention. Referring to master here will confuse new maintainers and may cause them to mis-configure protected-branch rules.
Please update the wording to main (or explicitly note that some historical repos still use master).
🤖 Prompt for AI Agents
In markdown/docs/community/040-guides/keep-repository-settings-consistent.md
around lines 17 to 18, the text refers to the branch name as "master" which is
outdated. Update the wording to use "main" instead of "master" to align with the
modern default branch naming convention used by AsyncAPI repositories, or add a
note explaining that some older repositories may still use "master".
| <center> | ||
| <a href="https://opencollective.com/asyncapi/contribute/platinum-sponsors-8119/checkout?interval=month&amount=2000" target="_blank"> | ||
| <img src="https://opencollective.com/asyncapi/donate/button@2x.png?color=blue" width=300 /> | ||
| </a> | ||
| </center> |
There was a problem hiding this comment.
Add alt text to images
<img> tags lack alt attributes, triggering MD045 and reducing accessibility. Provide concise alt text such as alt="Donate button".
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
32-32: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md around
lines 30 to 34, the <img> tag is missing an alt attribute, which reduces
accessibility and triggers MD045. Add a concise alt attribute to the <img> tag,
for example alt="Donate button", to improve accessibility compliance.
| - [How to submit a report](#how-to-submit-a-report) | ||
| - [Submit in writing](#submit-in-writing) | ||
| - [Submit in spoken conversation](#submit-in-spoken-conversation) | ||
| - [How to report anonymously](#how-to-report-anonymously) | ||
| - [What information to include in your report](#what-information-to-include-in-your-report) | ||
| - [What happens after a report is submitted](#what-happens-after-a-report-is-submitted) | ||
| - [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) | ||
| - [Mediation and Resolution by Agreement](#mediation-and-resolution-by-agreement) | ||
| - [Potential Remedies](#potential-remedies) |
There was a problem hiding this comment.
Fix list indentation and hard tabs
Sub-bullets under “How to submit a report” are indented inconsistently and include hard tabs, violating MD005/MD007/MD010. The current formatting breaks proper list rendering. Re-indent using spaces with two-space increments for each level.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
12-12: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
13-13: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 1
(MD005, list-indent)
13-13: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
14-14: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
15-15: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
15-15: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
16-16: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 2
(MD005, list-indent)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🤖 Prompt for AI Agents
In markdown/docs/community/COC-incident-resolution-procedures.md between lines 6
and 20, the sub-bullets under "How to submit a report" use inconsistent
indentation and hard tabs, causing improper list rendering. Replace all hard
tabs with spaces and re-indent the sub-bullets using two spaces per indentation
level to ensure consistent and correct markdown list formatting.
| languages: | ||
| - TypeScript | ||
| technology: | ||
| - TypeScript | ||
| categories: | ||
| - bundler | ||
| ``` |
There was a problem hiding this comment.
Schema mismatch: languages vs. language
The YAML example (and the AsyncAPI Bundler snippet) uses a languages: field, whereas the schema/table defines a singular language (string). This discrepancy will cause schema-validation errors in the automated workflow.
🤖 Prompt for AI Agents
In markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md around
lines 82 to 88, the YAML uses the plural field `languages` but the schema
expects a singular `language` string. Change the field name from `languages` to
`language` and ensure its value is a single string, not a list, to match the
schema and avoid validation errors.
| <p align="center"> | ||
| for</br> | ||
| AsyncAPI Project a Series of LF Projects, LLC</br> | ||
| Adopted 03-19-2021, Amended 05-05-2025 |
There was a problem hiding this comment.
Invalid HTML line-break tag
</br> is not a valid HTML tag. Replace with <br> (or <br />) to avoid rendering issues in some markdown engines.
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/CHARTER.md around lines 3
to 6, replace all occurrences of the invalid HTML line-break tag `</br>` with
the correct `<br>` or `<br />` tag to ensure proper rendering in markdown
engines.
| docs | ||
| | 2024 | Sept-Jan | In Progress | | [Sept-Jan](2024/README.md)| | ||
| | 2024 | Sep-Mar | In Progress | | In Progress | | ||
| master | ||
| | 2023 | Jan-Nov | Completed | | [Jan-Nov](2023/README.md) | | ||
| | 2022 | Jan-Nov | Completed | | [Jan-Nov](2022/README.md) | |
There was a problem hiding this comment.
Stray tokens break the markdown table
The words docs (line 8) and master (line 11) appear outside the table structure and disrupt rendering. Remove them or fold them into the nearest row.
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md
around lines 8 to 13, the words "docs" and "master" are outside the markdown
table and break its rendering. Remove these stray tokens or integrate them
properly into the table rows to maintain correct table formatting and ensure
proper display.
akshatnema
deleted the
update-community-docs-cca8cd992768b3c216a380d8258d6f457cea3f34
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Bug Fixes
Documentation