Skip to content

Conversation

@bandantonio
Copy link
Collaborator

@bandantonio bandantonio commented Jul 23, 2025

Description

Hotfix for #1975 after failed deploy in website repo: asyncapi/website#4268

Summary by CodeRabbit

  • Documentation
    • Improved consistency and readability across multiple documentation files through formatting adjustments, corrected heading levels, and standardized table and image tag syntax.
    • Fixed various typographical errors and enhanced clarity in project descriptions and guidelines.
    • Updated and clarified metadata in front matter, including commenting out or adjusting weight attributes and adding titles.
    • Refined and standardized links, including updates to resource URLs and markdown link formatting.
    • Enhanced the structure and hierarchy of tables of contents and section headings for easier navigation.

@coderabbitai
Copy link

coderabbitai bot commented Jul 23, 2025

Walkthrough

This update applies minor formatting, typographical, and metadata corrections across multiple documentation files. Changes include adjusting markdown tables, correcting typos, updating or commenting out YAML front matter fields, standardizing HTML tag syntax, refining link paths, and improving heading levels and list indentations. No code or logic was altered.

Changes

Files/Paths Change Summary
docs/000-onboarding/*.md, docs/030-project-vision-strategy-goals/ROADMAP.md, docs/070-marketing/social-media-communication-guidelines.md Commented out or adjusted weight attribute in YAML front matter.
docs/010-contribution-guidelines/conventional-commits.md, docs/000-onboarding/ambassador-guide.md Updated relative links to new paths or absolute URLs.
docs/011-styleguide/styling.md, docs/050-mentorship-program/seasonofdocs/2023/README.md, docs/050-mentorship-program/seasonofdocs/2023/project-ideas.md, docs/050-mentorship-program/summerofcode/2023/README.md Corrected typographical errors.
docs/020-governance-and-policies/CHARTER.md, docs/030-project-vision-strategy-goals/2025_marketing_strategy.md Standardized HTML tag syntax (e.g., <br />), fixed minor formatting.
docs/020-governance-and-policies/PROJECT_FUNDING.md, docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md Updated HTML attributes and self-closing tags for consistency.
docs/030-project-vision-strategy-goals/2025_Community_Goals.md Fixed code block formatting for Mermaid diagrams.
docs/050-mentorship-program/README.md, docs/050-mentorship-program/asyncapi-mentorship/README.md Reformatted markdown tables for alignment and clarity.
docs/050-mentorship-program/asyncapi-mentorship/2022/README.md Reformatted table syntax; removed one project entry.
docs/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md, docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md Added front matter metadata; corrected typos and improved table formatting and mentor info.
docs/050-mentorship-program/asyncapi-mentorship/2024/README.md Adjusted whitespace in table entries for consistency.
docs/050-mentorship-program/seasonofdocs/2022/README.md, docs/050-mentorship-program/winterofcode/2023/README.md Simplified markdown link formatting (removed angle brackets from URLs).
docs/050-mentorship-program/summerofcode/2021/README.md Replaced raw URLs with markdown links; fixed minor typo.
docs/050-mentorship-program/summerofcode/2024/README.md, docs/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md Added front matter metadata; corrected typo in project title.
docs/050-mentorship-program/summerofcode/application-template.md, docs/050-mentorship-program/summerofcode/mentors-guideline.md Standardized heading levels for improved structure.
docs/COC-incident-resolution-procedures.md Improved indentation of nested bullet points in the table of contents for clarity.
docs/070-marketing/webinar_planning_template.md Changed weight field value from quoted string to integer in YAML front matter.

Sequence Diagram(s)

Not generated, as changes are limited to documentation formatting, metadata, and minor textual corrections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • thulieblack
  • derberg

Poem

🐇
In docs we hop, with paws so neat,
Fixing typos, tables, every tiny feat.
We tidy weights and links anew,
For clarity and order, that's what we do!
With every nibble, docs shine bright—
A rabbit's touch makes all things right.

Note

⚡️ Unit Test Generation - Beta

CodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more here, or just try it under ✨ Finishing Touches.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 952571f and d8890f6.

📒 Files selected for processing (4)
  • docs/020-governance-and-policies/PROJECT_FUNDING.md (2 hunks)
  • docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1 hunks)
  • docs/050-mentorship-program/seasonofdocs/2023/README.md (1 hunks)
  • docs/050-mentorship-program/winterofcode/2023/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/050-mentorship-program/seasonofdocs/2023/README.md
  • docs/020-governance-and-policies/PROJECT_FUNDING.md
  • docs/050-mentorship-program/winterofcode/2023/README.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

🪛 LanguageTool
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md

[grammar] ~18-~18: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~32-~32: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@bandantonio bandantonio changed the title Docs/weights and frontmatter docs: Update weights and frontmatter Jul 23, 2025
@bandantonio bandantonio marked this pull request as draft July 23, 2025 21:03
@bandantonio bandantonio force-pushed the docs/weights-and-frontmatter branch from de92900 to 6c27ce6 Compare July 23, 2025 21:05
@bandantonio bandantonio force-pushed the docs/weights-and-frontmatter branch from 6c27ce6 to 0f3de66 Compare July 23, 2025 21:36
@bandantonio bandantonio changed the title docs: Update weights and frontmatter docs: update weights and frontmatter Jul 23, 2025
@bandantonio bandantonio marked this pull request as ready for review July 23, 2025 22:01
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🔭 Outside diff range comments (1)
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)

6-20: Remove the now-obsolete first ideas table to avoid conflicting content

There are two “Ideas list” tables in this file. Keeping both (old + new) is confusing for readers and for downstream tooling that scrapes the page.

-### Ideas list 
-
-Number | Idea | Area | Mentor/s| Scope |
-:---:|:---:|:---:|:---:|:---:|
-1| ...
-...
-8| ...
-
-### Ideas list
+# Ideas list   <!-- keep only this second section -->
♻️ Duplicate comments (1)
docs/020-governance-and-policies/PROJECT_FUNDING.md (1)

108-109: Duplicate issue – apply same alt attribute fix

🧹 Nitpick comments (18)
docs/010-contribution-guidelines/conventional-commits.md (1)

45-45: Use HEAD (or correct default branch) instead of hard-coding master in GitHub URL

Hard-coding master can break the link if the default branch is renamed (e.g., to main).
Switch to the branch-agnostic HEAD placeholder or the actual default branch to future-proof the doc.

- A PR title that does not follow this format will be rejected by our [Linting bot](https://github.com/asyncapi/community/blob/master/.github/workflows/lint-pr-title.yml), preventing the PR from being merged.  
+ A PR title that does not follow this format will be rejected by our [Linting bot](https://github.com/asyncapi/community/blob/HEAD/.github/workflows/lint-pr-title.yml), preventing the PR from being merged.  
docs/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)

64-67: Tighten wording for better clarity.

Sentence reads a bit awkwardly (“remains a dynamic and user-friendly for the upcoming …”) and repeats “improve” in the outcome line. Consider:

-Ensure our conference website remains a dynamic and user-friendly for the upcoming 2024 AsyncAPI Conference.
+Ensure our conference website remains dynamic and user-friendly ahead of the 2024 AsyncAPI Conference.
-
-🎯 **Outcome:** Improve the website's efficiency and user-friendliness for an improved user experience. 
+🎯 **Outcome:** Increase site efficiency and overall user experience.
docs/000-onboarding/where-to-contribute.md (1)

3-3: Double-check that commenting out weight fully resolves the build issue.

Hugo/YAML will ignore this line, but leaving stale metadata commented can confuse future maintainers. If the value is no longer needed, consider deleting the line entirely or adding a short inline note explaining why it’s disabled.

docs/000-onboarding/documentarian-onboarding-guide.md (1)

3-3: Consider removing or documenting the deprecated weight field.

Same remark as in the previous file—keeping commented-out config may mislead contributors skimming the front-matter. Either drop the line or add context (e.g., # weight: 30 # disabled – see PR #2000).

docs/070-marketing/social-media-communication-guidelines.md (1)

3-3: Consistent clean-up of obsolete front-matter.

If weight is intentionally unused across the docs set, a repo-wide sweep to delete the field rather than comment it out will keep front-matter minimal and avoid future re-activation by accident.

docs/000-onboarding/how-to-contribute.md (1)

3-3: Clarify intent of commented configuration.

For future clarity, add a brief note or remove the line to indicate that document ordering is now driven elsewhere (e.g., section index files).

docs/050-mentorship-program/summerofcode/application-template.md (1)

12-48: Heading level bump is consistent, but title hierarchy now skips H2 → H1 → H2

Good move switching all section headings from ### to ##.
However, the file still starts with an # at line 6, so the structure is now H1 ➜ H2 without an intermediate H2 “Overview/Introduction” section. It’s not wrong, but many downstream Markdown TOC generators emit warnings for this jump.

Consider either:

-# GSoC Application Template
+## GSoC Application Template

or introducing an intermediate section above the current ## headings.

docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)

52-52: Minor duplication: restream1.png is referenced twice with no distinguishing alt text.
If both screenshots are visually different, rename/replace one to avoid confusion; if identical, keep a single reference.

docs/050-mentorship-program/summerofcode/2021/README.md (2)

23-24: Tighten wording for clarity

The sentence is grammatically awkward. Suggested tweak maintains meaning while reading more cleanly:

-A library that as the input gets two AsyncAPI documents and shows changes between them.
+A library that takes two AsyncAPI documents as input and highlights the differences between them.

30-31: Trailing space & tense

There’s an extra space at line 30 and “so before summer there will be enough” mixes tenses. A quick tidy-up:

-We already started work on the [CLI](https://github.com/asyncapi/cli) so before summer there will be enough to plug in this functionality␠
+Work has already started on the [CLI](https://github.com/asyncapi/cli), so before summer there should be enough to plug in this functionality.
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)

23-33: Fix markdown-lint violations (trailing pipes & header alignment)

markdownlint (MD055) is flagging every row because of the trailing |.
Dropping the last pipe and left-aligning non-numeric columns will silence the linter and render a cleaner table.

-:---:|---|:---:|:---:|---|
+:---:|---|:---:|:---:|---      <!-- no trailing pipe -->
 
-1 | … | AsyncAPI CLI | … | … |
+1 | … | AsyncAPI CLI | … | …      <!-- removed trailing pipe -->
docs/050-mentorship-program/seasonofdocs/2022/README.md (1)

14-15: Replace bare Twitter URLs with markdown links

Same MD034 issue as in the WOC file.

- Alejandra Quetzalli ([@alequetzalli](https://github.com/alequetzalli)): https://twitter.com/QuetzalliWrites
- Lukasz Gornicki ([@derberg](https://github.com/derberg)): https://twitter.com/derberq
+ Alejandra Quetzalli ([@alequetzalli](https://github.com/alequetzalli)): [@QuetzalliWrites](https://twitter.com/QuetzalliWrites)
+ Łukasz Górnicki ([@derberg](https://github.com/derberg)): [@derberg](https://twitter.com/derberg)
docs/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)

26-26: Convert bare URL to a proper Markdown link inside the table row.

https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788 violates MD034 (no-bare-urls) and renders poorly in some Markdown engines.

-<del>6</del> | <del>[Library for easier integration testing of code generators](https://github.com/asyncapi/generator/issues/752)</del> | [Generator](https://github.com/asyncapi/generator) | @derberg | 7 | https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788 |
+<del>6</del> | <del>[Library for easier integration testing of code generators](https://github.com/asyncapi/generator/issues/752)</del> | [Generator](https://github.com/asyncapi/generator) | @derberg | 7 | [discussion] (https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788) |
docs/030-project-vision-strategy-goals/2025_marketing_strategy.md (1)

56-56: Fix typo and spacing in Goal 3 row.

Minor polish: add a space after Goal 3: and correct MastadonMastodon.

-| **Goal 3:Drive Community Engagement**          |    | ...Slack, GitHub, LinkedIn, Mastadon, YouTube, and Twitter...
+| **Goal 3: Drive Community Engagement**          |    | ...Slack, GitHub, LinkedIn, Mastodon, YouTube, and Twitter...
docs/050-mentorship-program/asyncapi-mentorship/README.md (4)

12-16: Add blank lines around the “docs” table to satisfy MD058.

 ### docs
+ 
 | Year | Term | Status | Announcement | Details |
 | ---- | ---- | ------ | ------------ | ------- |
@@
 | 2024 | Sep-Mar | In Progress  |       | In Progress |
+ 

19-23: Same MD058 issue for the “master” table.

 ### master
+ 
 | Year | Term | Status | Announcement | Details |
 | ---- | ---- | ------ | ------------ | ------- |
@@
 | 2022 | Jan-Nov | Completed   |       | [Jan-Nov](2022/README.md) |
+ 

28-29: Replace bare profile URLs with Markdown links.

-- Azeez Elegbede ([@acethecreator](https://github.com/acethecreator)): https://twitter.com/_acebuild
-- Thulisile Sibanda ([@thulieblack](https://github.com/thulieblack)): https://www.linkedin.com/in/v-thulisile-sibanda/
+- Azeez Elegbede ([@acethecreator](https://github.com/acethecreator)): [Twitter](https://twitter.com/_acebuild)
+- Thulisile Sibanda ([@thulieblack](https://github.com/thulieblack)): [LinkedIn](https://www.linkedin.com/in/v-thulisile-sibanda/)

84-84: Minor wording tweak for clarity.

still needs to meetdoes not meet.

- Suppose AsyncAPI reasonably believes that a Mentor still needs to meet the primary responsibilities.
+ Suppose AsyncAPI reasonably believes that a Mentor does not meet the primary responsibilities.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e1240dc and 952571f.

📒 Files selected for processing (31)
  • docs/000-onboarding/ambassador-guide.md (1 hunks)
  • docs/000-onboarding/documentarian-onboarding-guide.md (1 hunks)
  • docs/000-onboarding/how-to-contribute.md (1 hunks)
  • docs/000-onboarding/where-to-contribute.md (1 hunks)
  • docs/010-contribution-guidelines/conventional-commits.md (1 hunks)
  • docs/011-styleguide/styling.md (1 hunks)
  • docs/020-governance-and-policies/CHARTER.md (1 hunks)
  • docs/020-governance-and-policies/PROJECT_FUNDING.md (2 hunks)
  • docs/030-project-vision-strategy-goals/2025_Community_Goals.md (2 hunks)
  • docs/030-project-vision-strategy-goals/2025_marketing_strategy.md (1 hunks)
  • docs/030-project-vision-strategy-goals/ROADMAP.md (1 hunks)
  • docs/050-mentorship-program/README.md (1 hunks)
  • docs/050-mentorship-program/asyncapi-mentorship/2022/README.md (1 hunks)
  • docs/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (1 hunks)
  • docs/050-mentorship-program/asyncapi-mentorship/2024/README.md (1 hunks)
  • docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1 hunks)
  • docs/050-mentorship-program/asyncapi-mentorship/README.md (2 hunks)
  • docs/050-mentorship-program/seasonofdocs/2022/README.md (1 hunks)
  • docs/050-mentorship-program/seasonofdocs/2023/README.md (1 hunks)
  • docs/050-mentorship-program/seasonofdocs/2023/project-ideas.md (1 hunks)
  • docs/050-mentorship-program/summerofcode/2021/README.md (2 hunks)
  • docs/050-mentorship-program/summerofcode/2023/README.md (1 hunks)
  • docs/050-mentorship-program/summerofcode/2024/README.md (1 hunks)
  • docs/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1 hunks)
  • docs/050-mentorship-program/summerofcode/application-template.md (4 hunks)
  • docs/050-mentorship-program/summerofcode/mentors-guideline.md (2 hunks)
  • docs/050-mentorship-program/winterofcode/2023/README.md (1 hunks)
  • docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2 hunks)
  • docs/070-marketing/social-media-communication-guidelines.md (1 hunks)
  • docs/070-marketing/webinar_planning_template.md (1 hunks)
  • docs/COC-incident-resolution-procedures.md (1 hunks)
🧰 Additional context used
🧠 Learnings (10)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/000-onboarding/where-to-contribute.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/050-mentorship-program/seasonofdocs/2023/README.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/050-mentorship-program/seasonofdocs/2023/project-ideas.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/000-onboarding/ambassador-guide.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/050-mentorship-program/summerofcode/2021/README.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/010-contribution-guidelines/conventional-commits.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/050-mentorship-program/asyncapi-mentorship/README.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

docs/000-onboarding/how-to-contribute.md (1)

Learnt from: thulieblack
PR: #1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, docs/onboarding-guide/contribution-flow.md is the correct path for contribution flow documentation, not docs/community/onboarding-guide/contribution-flow.md.

🪛 markdownlint-cli2 (0.17.2)
docs/020-governance-and-policies/PROJECT_FUNDING.md

37-37: Images should have alternate text (alt text)

(MD045, no-alt-text)


108-108: Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/050-mentorship-program/winterofcode/2023/README.md

11-11: Bare URL used

(MD034, no-bare-urls)


12-12: Bare URL used

(MD034, no-bare-urls)

docs/050-mentorship-program/asyncapi-mentorship/2022/README.md

26-26: Bare URL used

(MD034, no-bare-urls)

docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md

52-52: Images should have alternate text (alt text)

(MD045, no-alt-text)


56-56: Images should have alternate text (alt text)

(MD045, no-alt-text)


63-63: Images should have alternate text (alt text)

(MD045, no-alt-text)


89-89: Images should have alternate text (alt text)

(MD045, no-alt-text)


93-93: Images should have alternate text (alt text)

(MD045, no-alt-text)


97-97: Images should have alternate text (alt text)

(MD045, no-alt-text)


99-99: Images should have alternate text (alt text)

(MD045, no-alt-text)


101-101: Images should have alternate text (alt text)

(MD045, no-alt-text)


105-105: Images should have alternate text (alt text)

(MD045, no-alt-text)


109-109: Images should have alternate text (alt text)

(MD045, no-alt-text)


115-115: Images should have alternate text (alt text)

(MD045, no-alt-text)


122-122: Images should have alternate text (alt text)

(MD045, no-alt-text)


126-126: Images should have alternate text (alt text)

(MD045, no-alt-text)


130-130: Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/050-mentorship-program/asyncapi-mentorship/README.md

13-13: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)


20-20: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)


28-28: Bare URL used

(MD034, no-bare-urls)


29-29: Bare URL used

(MD034, no-bare-urls)

docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md

29-29: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe

(MD055, table-pipe-style)


30-30: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe

(MD055, table-pipe-style)


31-31: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe

(MD055, table-pipe-style)


32-32: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe

(MD055, table-pipe-style)


33-33: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe

(MD055, table-pipe-style)


37-37: Images should have alternate text (alt text)

(MD045, no-alt-text)

🪛 LanguageTool
docs/050-mentorship-program/seasonofdocs/2023/README.md

[grammar] ~18-~18: Ensure spelling is correct
Context: ...esent only on server A or server B. - Specifyng dynamic parts of channel name - Expla...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

docs/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md

[style] ~27-~27: Consider a different adjective to strengthen your wording.
Context: ...ub.com/asyncapi/cli) | @fmvilas | We're doing a great job at Glee and Generator and it's about th...

(DO_A_GREAT_JOB)


[style] ~30-~30: ‘in difficulty’ might be wordy. Consider a shorter alternative.
Context: ... is probably the most complicated issue in difficulty. If we want people to adopt Glee in pro...

(EN_WORDINESS_PREMIUM_IN_DIFFICULTY)

docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md

[grammar] ~32-~32: Ensure spelling is correct
Context: ...s. The project involves integrating the EDAVisualiser library, implementing a configuration s...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

docs/030-project-vision-strategy-goals/2025_marketing_strategy.md

[uncategorized] ~55-~55: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s can connect and collaborate.
- Open Source Contributions: Encourage contributions ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[grammar] ~56-~56: Ensure spelling is correct
Context: ...platforms like Slack, GitHub, LinkedIn, Mastadon, YouTube, and Twitter to facilitate dis...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (16)
docs/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (1)

63-63: Typo fix looks good.

The correction from “Maintainance” ➜ “Maintenance” improves professionalism and consistency with the related README file.

docs/050-mentorship-program/summerofcode/2024/README.md (2)

1-4: Front-matter addition is fine.

Title/weight values render correctly and match neighbouring docs (ideas page weight = 180, README = 170), preserving navigation order.


38-38: Typo alignment confirmed.

Row 7 now uses “Maintenance”, matching the ideas page. Nothing else needed.

docs/030-project-vision-strategy-goals/ROADMAP.md (1)

3-3: Flagging potential menu ordering side-effects.

Removing the numeric weight might change the order in site navigation. Verify that the rendered menu/TOC still matches the desired sequence after the hotfix.

docs/070-marketing/webinar_planning_template.md (1)

3-3: Confirm weight type consistency across all docs

Switching from a quoted string to an integer looks correct for Hugo-style front-matter, but other files in this PR comment the weight field out entirely. Double-check that leaving this file’s weight active (and numeric) won’t reintroduce ordering issues the hot-fix is trying to solve.

docs/050-mentorship-program/seasonofdocs/2023/project-ideas.md (1)

17-17: Typo fixed correctly – looks good.

The previously misspelled “Specifing” is now “Specifying”. 👍

docs/011-styleguide/styling.md (1)

213-214: Typo fix looks good

The correction from “decriptive” to “descriptive” improves clarity and aligns with the surrounding guidance.

docs/050-mentorship-program/summerofcode/2023/README.md (1)

50-53: Minor text clean-up approved

The spelling correction and proper “Node.js” capitalization improve professionalism without altering meaning.

docs/020-governance-and-policies/CHARTER.md (1)

8-9: Correct use of <br /> self-closing tag

Switching from the deprecated </br> to <br /> follows HTML spec and avoids rendering quirks.

docs/050-mentorship-program/summerofcode/mentors-guideline.md (1)

8-30: Heading level standardization approved

Promoting all major sections to ## ensures consistent hierarchy and improves navigation tooling.

docs/030-project-vision-strategy-goals/2025_Community_Goals.md (1)

42-61: Mermaid fence fixed – LGTM

Switching from mermaid tomermaid eliminates rendering glitches in some MD engines. No further issues spotted.

docs/COC-incident-resolution-procedures.md (1)

12-23: Indentation fix aligns TOC levels – LGTM

Indenting sub-items under “Confirmation and Jurisdiction” and “Potential Remedies” correctly reflects hierarchy and resolves broken anchor nesting in some Markdown viewers.

docs/000-onboarding/ambassador-guide.md (1)

40-42: Validate the new relative path before merging

../020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md looks OK, but the file was previously under the mentorship tree. Please confirm the target exists after the docs re-org; otherwise this will lead to a 404.

docs/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)

19-20: LGTM – spacing fix only

Trimming the leading spaces in the first two rows makes the table consistent. No further action needed.

docs/050-mentorship-program/README.md (1)

23-30: Table re-format looks good.
The column alignment and separator consistency are much clearer now. 👍

docs/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (1)

26-31: LGTM on the typo & line-break fixes.

The <br /> self-closing tags and corrected wording improve readability without altering meaning.

@bandantonio
Copy link
Collaborator Author

@thulieblack Fix is ready

@thulieblack
Copy link
Member

🤞🏿🤞🏿

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 21f8088 into asyncapi:master Jul 24, 2025
10 checks passed
@thulieblack
Copy link
Member

@bandantonio, we are close, just check the Netlify build errors https://app.netlify.com/projects/asyncapi-website/deploys/688242ccf3897d00087498e7

I realised if I close the PR you won't see them

@aeworxet
Copy link
Contributor

@asyncapi/bounty_team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Completed

Development

Successfully merging this pull request may close these issues.

4 participants