docs: update/add weights and frontmatter for community docs #1975
Conversation
bandantonio
requested review from
a team,
asyncapi-bot-eve,
derberg,
quetzalliwrites and
thulieblack
as code owners
WalkthroughThis update standardizes and adds YAML front matter metadata (title and weight) to numerous documentation markdown files, adjusts document weights for logical ordering, and updates internal and external links to use relative paths or correct URLs. No functional or structural changes to the documentation content or exported entities are present. Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (7)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (4)
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
CodeRabbit Configuration File (
|
bandantonio
changed the title
bandantonio
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🔭 Outside diff range comments (2)
docs/010-contribution-guidelines/contribution-flow.md (1)
28-35: Broken links to the Git-workflow guide after the folder reshuffle.Both occurrences still point to
/asyncapi/community/blob/master/git-workflow.md, which no longer exists.
Updating to a relative path keeps the link valid on GitHub and in the generated site.-1. Set up your workflow environment using the [git workflow guide](/asyncapi/community/blob/master/git-workflow.md). +1. Set up your workflow environment using the [git-workflow guide](./git-workflow.md). @@ -7. Follow the [git workflow document](/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR. +7. Follow the [git-workflow document](./git-workflow.md) when working on your changes and making a PR.docs/030-project-vision-strategy-goals/2025_marketing_strategy.md (1)
17-21: Duplicate introduction paragraph – remove the second copyLines 18-20 repeat the same paragraph almost verbatim, which hurts readability.
@@ -Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant community and ignite a passion for event-driven architecture and asynchronous APIs through AsyncAPI adoption. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture. All are powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment. - -Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant developer community and ignite a passion for event-driven architecture and asynchronous APIs. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture. All are powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment. +Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant developer community and ignite a passion for event-driven architecture and asynchronous APIs. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture, all powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment.
🧹 Nitpick comments (20)
docs/050-mentorship-program/seasonofdocs/2023/project-ideas.md (1)
1-4: Demote or drop the duplicate H1 headingThe page already gets its title from the front-matter. Keeping the top-level Markdown heading (
# 2023 GSoD Accepted Projects) duplicates the title and can hurt SEO/accessibility.-# 2023 GSoD Accepted Projects +## 2023 GSoD Accepted Projectsdocs/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (1)
1-4: Consider aligning filename with the rest of the docsMost pages use
README.mdorindex.md. Using the uppercaseAMBASSADOR_PROGRAM.mdis fine technically, but a consistent naming convention simplifies linking and future automation.Rename to
README.md(orindex.md) and update inbound links, if any.docs/050-mentorship-program/summerofcode/application-template.md (1)
1-4: Minor duplication: title appears twiceFront-matter defines
title: GSoC Application Template, but the Markdown body repeats the same text as an H1. Most site generators render the front-matter title automatically, so the extra# GSoC Application Template(line 6) may create a duplicated heading.
Consider downgrading the body heading to##or removing it.docs/060-meetings-and-communication/slack-etiquette.md (1)
2-3: Inconsistent use of quotes in titleOther updated docs dropped the single quotes around the
title:value; this file keeps them.
YAML doesn’t mind, but the inconsistency may trip future bulk tooling or grep scripts. Recommend removing the quotes for uniformity.-title: 'Adhering to Slack Etiquette' +title: Adhering to Slack Etiquettedocs/060-meetings-and-communication/docs-community.md (1)
1-4: Title casing is inconsistent with surrounding docsMost page titles follow “Title Case”, e.g. “AsyncAPI Docs Community”.
Consider capitalising Docs and Community for consistency with navigation and search results:-title: 'AsyncAPI docs community' +title: 'AsyncAPI Docs Community'docs/010-contribution-guidelines/git-workflow.md (1)
1-4: Minor nit: add an explicitdescriptionfor better SEO / previews.Several other docs in the tree expose a
description:field in the front-matter; adding it here keeps metadata consistent and improves search snippets.--- title: Git Workflow weight: 50 +description: Best-practice Git workflow for contributing to AsyncAPI repositories. ---docs/030-project-vision-strategy-goals/_section.md (1)
1-4: Section weight appears off-by-one relative to folder numberingFolder
030-*suggests this is the third top-level section, yet its weight is50while020-*is currently40.
If the intention is “+10 per section”,030should be50only when020is40→ gap at30. Please double-check the complete_section.mdset and normalise the sequence to avoid unexpected menu ordering.-weight: 50 +# weight: 30 # or 50 – align after auditing the whole setdocs/050-mentorship-program/summerofcode/mentors-guideline.md (1)
1-4: Quote the title to avoid YAML edge-cases with the apostropheThe plain scalar containing an apostrophe can trip some YAML parsers. Safer to wrap the value in double quotes.
-title: GSoC Mentor's Guideline +title: "GSoC Mentor's Guideline"docs/010-contribution-guidelines/_section.md (1)
1-4: Weight sequence gap after 010-sectionThis section uses weight
20, which fits the “+10” pattern if000is10.
However,_section.mdunder020-*is currently40, leaving30unused.
Consider auditing and closing the gap to keep ordering predictable.docs/020-governance-and-policies/PROJECT_FUNDING.md (1)
1-4: Title length may hurt sidebar readabilityThe 80-character title will be used as the nav label; most sidebars truncate long labels making them unreadable.
Suggest shortening to something like “Project Funding” while keeping the full phrase as the first markdown heading in the body.docs/060-meetings-and-communication/_section.md (1)
1-4: Minor title-case tweakUse standard title-case (
Meetings and Communication) instead of capitalising the conjunction “And”.-title: Meetings And Communication +title: Meetings and Communicationdocs/010-contribution-guidelines/BOUNTY_PROGRAM.md (1)
1-4: Consider removing the redundant top-level headingNow that the YAML
titleis present, most static-site generators (Hugo, Docusaurus, etc.) automatically render it as the page’s<h1>.
Keeping the manual# AsyncAPI Bounty Programon line 6 will result in two identical headings.-# AsyncAPI Bounty ProgramIf your chosen generator does not auto-inject the
<h1>, keep the Markdown heading, otherwise drop it to avoid duplication.docs/020-governance-and-policies/introduction-of-changes-to-spec.md (1)
1-4: Potential duplicate<h1>Same note as above: the front-matter
titleis likely rendered as the page heading.
If so, delete the manual"## How changes in the spec are introduced"line or downgrade it to###to keep a single primary heading.docs/050-mentorship-program/summerofcode/README.md (1)
1-4: Double heading checkFront-matter already supplies the page title.
Verify whether the# Google Summer of Code - Getting Startedheading (line 6) should be removed or demoted to eliminate duplicate H1s.docs/010-contribution-guidelines/contribute-blog-post.md (1)
1-4: Duplicate title questionWith the new YAML block, the explicit
## Contribute AsyncAPI blog postsheading (line 6) might produce a repeated page title.
Confirm your site generator’s behaviour and drop/demote the Markdown heading if unnecessary.docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
1-4: Metadata added, but consider adding an explicit H1 headerThe front-matter is syntactically correct and enables proper weighting.
Because the file now starts straight with body text, search engines and MDX/Gatsby generators sometimes rely on the first#heading for page titles. Adding# Meetings Organizationimmediately after the front-matter can improve SEO and anchor-linking without affecting existing content.
docs/010-contribution-guidelines/open-docs-pull-request.md (1)
2-3: Title/weight change fine; minor link driftAll YAML looks good. Note that bullet 11 below still links to
.github/blob/master/CONTRIBUTING.md. Ifmainhas replacedmaster, consider updating to avoid 404s.docs/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1)
1-4: Verify weight uniqueness & avoid duplicate page titles
weight: 140looks plausible, but please cross-check this folder for other files already using140to avoid deterministic-order clashes.
Also remember that many static-site generators automatically render the front-mattertitleas an<h1>; keeping the explicit### Become Maintainer...heading below may result in double titles.docs/050-mentorship-program/asyncapi-mentorship/README.md (1)
1-4: Minor clean-up: drop redundant headingSame remark as above – retaining both the front-matter
titleand the# AsyncAPI Mentorship Programheading usually produces duplicate top-level headings in the rendered page. Removing the Markdown heading keeps the page cleaner.docs/050-mentorship-program/winterofcode/2023/README.md (1)
1-4: Consistent heading strategyConsider deleting the
# Status: In Progressheading or demoting it to an<h2>to keep a single<h1>coming from the front-mattertitle, otherwise the page begins with two consecutive primary headings.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (80)
docs/000-onboarding/_section.md(1 hunks)docs/000-onboarding/ambassador-guide.md(2 hunks)docs/000-onboarding/docs-onboarding-checklist.md(1 hunks)docs/000-onboarding/documentarian-onboarding-guide.md(1 hunks)docs/000-onboarding/github-actions.md(1 hunks)docs/000-onboarding/how-to-contribute.md(1 hunks)docs/000-onboarding/index.md(1 hunks)docs/000-onboarding/maintainer-guide.md(1 hunks)docs/000-onboarding/upholding-code-of-conduct.md(1 hunks)docs/000-onboarding/where-to-contribute.md(1 hunks)docs/010-contribution-guidelines/BOUNTY_PROGRAM.md(1 hunks)docs/010-contribution-guidelines/Become-maintainer-in-existing-project.md(1 hunks)docs/010-contribution-guidelines/_section.md(1 hunks)docs/010-contribution-guidelines/code-contributor-guide.md(1 hunks)docs/010-contribution-guidelines/contribute-blog-post.md(1 hunks)docs/010-contribution-guidelines/contribute-to-docs.md(1 hunks)docs/010-contribution-guidelines/contribution-flow.md(1 hunks)docs/010-contribution-guidelines/conventional-commits.md(1 hunks)docs/010-contribution-guidelines/create-new-docs-directories.md(1 hunks)docs/010-contribution-guidelines/git-workflow.md(1 hunks)docs/010-contribution-guidelines/identifying-good-first-issues.md(1 hunks)docs/010-contribution-guidelines/mentoring-maintainers.md(1 hunks)docs/010-contribution-guidelines/open-docs-pull-request.md(1 hunks)docs/010-contribution-guidelines/prerequisite-knowledge.md(1 hunks)docs/010-contribution-guidelines/recognize-contributors.md(1 hunks)docs/010-contribution-guidelines/technical-writer-contributor-responsibilities.md(1 hunks)docs/010-contribution-guidelines/tools-and-setup.md(1 hunks)docs/011-styleguide/_section.md(1 hunks)docs/011-styleguide/content-buckets.md(1 hunks)docs/011-styleguide/formatting.md(1 hunks)docs/011-styleguide/glossary.md(1 hunks)docs/011-styleguide/grammar.md(1 hunks)docs/011-styleguide/inclusive-language.md(1 hunks)docs/011-styleguide/index.md(1 hunks)docs/011-styleguide/links.md(1 hunks)docs/011-styleguide/numbers.md(1 hunks)docs/011-styleguide/punctuation.md(1 hunks)docs/011-styleguide/seo-guide.md(1 hunks)docs/011-styleguide/version-control.md(1 hunks)docs/011-styleguide/voice-and-tone.md(1 hunks)docs/020-governance-and-policies/CHARTER.md(1 hunks)docs/020-governance-and-policies/GOVERNANCE.md(3 hunks)docs/020-governance-and-policies/PROJECT_FUNDING.md(1 hunks)docs/020-governance-and-policies/TSC_MEMBERSHIP.md(1 hunks)docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md(1 hunks)docs/020-governance-and-policies/WORKING_GROUPS.md(1 hunks)docs/020-governance-and-policies/_section.md(1 hunks)docs/020-governance-and-policies/donating-projects.md(1 hunks)docs/020-governance-and-policies/introduction-of-changes-to-spec.md(1 hunks)docs/020-governance-and-policies/voting.md(1 hunks)docs/030-project-vision-strategy-goals/2025_Community_Goals.md(1 hunks)docs/030-project-vision-strategy-goals/2025_marketing_strategy.md(1 hunks)docs/030-project-vision-strategy-goals/ROADMAP.md(1 hunks)docs/030-project-vision-strategy-goals/_section.md(1 hunks)docs/040-guides/_section.md(1 hunks)docs/040-guides/add-new-asyncapi-tool-to-website.md(1 hunks)docs/040-guides/keep-repository-settings-consistent.md(1 hunks)docs/050-mentorship-program/README.md(1 hunks)docs/050-mentorship-program/_section.md(1 hunks)docs/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship/2022/README.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship/2023/README.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship/2024/README.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship/README.md(1 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(1 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/README.md(1 hunks)docs/050-mentorship-program/summerofcode/application-template.md(1 hunks)docs/050-mentorship-program/summerofcode/mentors-guideline.md(1 hunks)docs/050-mentorship-program/winterofcode/2023/README.md(1 hunks)docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)docs/060-meetings-and-communication/_section.md(1 hunks)docs/060-meetings-and-communication/docs-community.md(1 hunks)docs/060-meetings-and-communication/slack-etiquette.md(1 hunks)docs/070-marketing/_section.md(1 hunks)docs/070-marketing/social-media-communication-guidelines.md(1 hunks)
🧰 Additional context used
🧠 Learnings (21)
📓 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/010-contribution-guidelines/code-contributor-guide.md (1)
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/ambassador-guide.md (1)
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/010-contribution-guidelines/identifying-good-first-issues.md (1)
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/010-contribution-guidelines/contribute-to-docs.md (1)
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/010-contribution-guidelines/contribution-flow.md (1)
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/_section.md (1)
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/how-to-contribute.md (1)
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/011-styleguide/version-control.md (1)
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/060-meetings-and-communication/docs-community.md (1)
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/010-contribution-guidelines/_section.md (1)
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/010-contribution-guidelines/git-workflow.md (1)
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/010-contribution-guidelines/technical-writer-contributor-responsibilities.md (1)
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/011-styleguide/index.md (1)
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/upholding-code-of-conduct.md (1)
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/010-contribution-guidelines/contribute-blog-post.md (1)
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/docs-onboarding-checklist.md (1)
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: 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/010-contribution-guidelines/create-new-docs-directories.md (1)
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/010-contribution-guidelines/open-docs-pull-request.md (1)
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/maintainer-guide.md (1)
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`.
🔇 Additional comments (55)
docs/011-styleguide/links.md (1)
4-4: Weight update aligns with the new ordering scheme – looks good.
No functional or structural impact beyond navigation ordering.docs/011-styleguide/seo-guide.md (1)
4-4: Weight adjusted from 140 → 130 – consistent with the reordered sequence.docs/011-styleguide/version-control.md (2)
4-4: Weight lowered to 150 – matches the new 10-increment rhythm.
8-8: Minor prose tweak detected – content still reads well.
No style or terminology issues introduced.docs/011-styleguide/voice-and-tone.md (1)
4-4: Weight change (70 → 60) acknowledged – ordering unaffected elsewhere.docs/011-styleguide/inclusive-language.md (1)
4-4: Weight change (60 → 50) fits the revised hierarchy – no other modifications.docs/011-styleguide/grammar.md (1)
1-5: No duplicateweight: 70in docs/011-styleguide
The only occurrence ofweight: 70is indocs/011-styleguide/grammar.md. All other files use distinct weight values.docs/011-styleguide/punctuation.md (1)
1-5: Weight update consistent with ordering
weight: 90slots this file after “Numbers” (80) and before the next 100-series items—no issues spotted.docs/011-styleguide/numbers.md (1)
1-5: Weight adjustment acknowledged
weight: 80keeps the incremental sequence intact. No further action needed.docs/011-styleguide/glossary.md (1)
1-5: Weight lowered to 160 — OKNo functional concerns; just keep an eye on maintaining 10-increment spacing for future additions.
docs/011-styleguide/formatting.md (1)
1-5: Weight adjustment looks correct—verify no collisions with sibling docsMoving the
weightfrom 110 → 100 keeps the 10-step convention and improves ordering.
Please run a quick scan to confirm no other file indocs/011-styleguide/now shares weight 100.docs/011-styleguide/index.md (1)
1-3: Un-quoting the YAML title is fine—ensure repo-wide consistencyYAML handles bare words here, so the change is harmless. Double-check that all titles across the Style Guide now follow the same quoting rule to avoid mixed styles.
docs/011-styleguide/_section.md (1)
1-4: Front-matter cleanup & weight update look goodCapitalization fix, delimiter correction, and weight 30 all align with the new hierarchy. No further action needed.
docs/020-governance-and-policies/_section.md (1)
2-4: Check title-case consistency and weight alignment
- Title: other section titles seem to use sentence-case (“and” lowercase), e.g. “Contribution guidelines”. Consider
Governance and Policiesfor consistency.- Weight: folder prefix is
020, yet the section weight is40. Verify that this matches the global 10-increment ordering you introduced (000→10,010→20, …).No functional harm, but worth double-checking before merging.
docs/020-governance-and-policies/WORKING_GROUPS.md (2)
1-4: Front-matter weight appears high relative to siblingsA weight of
70inside the020-governance-and-policiesfolder will push “Working Groups” after any docs weighted ≤60 in the same folder. Confirm this is intentional and that other files (e.g. CHARTER, GOVERNANCE) have lower weights so the reading order is correct.
33-38: Sanity-check relative links after folder shuffleThe three links reference
../../WORKING_GROUPS.yaml. After the new hierarchy this resolves to the repository root. If the YAML file was also moved intodocs/, these links will 404. Please run a quick link check.docs/040-guides/_section.md (1)
1-4: LGTM – section marker is correctMetadata is minimal, syntactically valid, and weight
60fits the 10-step pattern between 020 (40) and 050 (70).docs/050-mentorship-program/_section.md (1)
1-4: LGTM – mentorship section registeredFront-matter is valid and weight
70positions the section straight after Guides (60).docs/050-mentorship-program/summerofcode/2023/README.md (1)
1-4: Verify intra-section orderingWithin the Mentorship Program, this doc has weight
130. Confirm that earlier/later years have weights (110,120, etc.) to keep chronological order; otherwise adjust.docs/050-mentorship-program/summerofcode/2021/README.md (1)
1-4: Weight uniqueness verified — no duplicates foundI ran the suggested check across all
docs/050-mentorship-program/**/README.mdfiles and found no duplicateweightvalues. Ready to merge.docs/040-guides/keep-repository-settings-consistent.md (1)
1-4: Front-matter addition LGTMTitle and weight are valid, YAML is well-formed, and there’s a blank line after the closing delimiter.
docs/040-guides/add-new-asyncapi-tool-to-website.md (1)
1-5: Weight field added correctlyFront-matter now has
weight: 20; formatting remains valid and the change won’t affect the existingtitleordescription.docs/020-governance-and-policies/donating-projects.md (1)
1-4: Front-matter looks goodYAML block is well-formed, title capitalization is consistent with the rest of the section, and the weight (80) preserves the ×10 convention.
No further action needed.docs/010-contribution-guidelines/identifying-good-first-issues.md (1)
4-4: Weight change acknowledgedWeight updated to 40, which keeps the 10-step ordering scheme. No other issues spotted.
docs/000-onboarding/_section.md (1)
2-2: Title tweak is fineRenaming the section to “Onboarding” is concise and clear; front-matter remains valid.
docs/010-contribution-guidelines/code-contributor-guide.md (1)
4-4: Weight adjusted to 70The new weight fits the folder’s 10-increment pattern. Verify that no sibling file already uses 70 to avoid nav clashes, but otherwise all good.
docs/000-onboarding/index.md (1)
2-3: Front-matter weight looks correct, but double-check section orderingIndex pages in the new scheme are supposed to carry weight 5, so this edit aligns with the pattern.
Just make sure no other file inside000-onboarding/also uses weight 5, otherwise the ordering becomes undefined.docs/010-contribution-guidelines/conventional-commits.md (1)
4-4: Weight change LGTMMoving this guide to weight 60 correctly positions it after basics such as Git workflow while before advanced topics.
No further action required.docs/000-onboarding/github-actions.md (1)
2-3: Minor weight adjustment acknowledgedWeight 80 puts this technical topic late in the onboarding stream, which makes sense.
Nothing else changed—looks good.docs/030-project-vision-strategy-goals/ROADMAP.md (1)
1-4: Front-matter added—verify weight uniquenessGreat to see the front-matter added. Weight 30 should slot this after intro / vision docs, but run a quick grep across
030-project-vision-strategy-goalsto ensure no other file already owns 30.docs/010-contribution-guidelines/tools-and-setup.md (1)
2-3: Good alignment of title/weight with the new hierarchyCapitalisation fixed and weight lowered to 30, which now places this page early in the “Getting started” subsection. No further issues spotted.
docs/010-contribution-guidelines/mentoring-maintainers.md (1)
2-2: No broken anchor links after title updateRan
rg -n '\(#strategies-for-mentoring-new-maintainers\)' docsand found no matches—there are no internal links pointing to the new slug. Safe to merge.docs/070-marketing/_section.md (1)
1-4: Section stub added correctlyFront-matter looks fine; weight
90keeps the global 10-increment pattern.docs/000-onboarding/documentarian-onboarding-guide.md (1)
1-4: Weight 30 is unique within docs/000-onboarding
No other file indocs/000-onboarding/usesweight: 30; build order for this page is deterministic.docs/000-onboarding/how-to-contribute.md (1)
1-4: Front-matter looks good – confirm weight collision
weight: 20is consistent with the 10-increment convention.
Run the same script suggested in the previous comment to be sure 20 is unique.docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (1)
1-4: Add front-matter generation to the automation scriptThis file is regenerated by a script (see line 6).
Unless the script itself now writes thetitle/weightblock, the next run will overwrite these lines.If the script is in this repo, please update it to prepend:
+--- +title: TSC Voting Overview +weight: 50 +---before emitting the table.
docs/070-marketing/social-media-communication-guidelines.md (1)
1-4: Metadata accepted – remember to keep weights unique
weight: 10will push this doc to the top of the Marketing section.
Looks fine as long as_section.md(weight 90) and siblings don’t reuse 10.docs/010-contribution-guidelines/technical-writer-contributor-responsibilities.md (1)
2-3: Weight jump to 100 – confirm intended orderingOther docs in this folder appear to top out at 90. If this page is supposed to come last, 100 is perfect; otherwise consider bringing it back into the 10-step sequence.
docs/010-contribution-guidelines/recognize-contributors.md (1)
1-4: Front-matter looks good — please just double-check weight collisions.The YAML block is syntactically correct and follows the new 10-increment convention, but 130 is at the very top end of the guideline set.
Quickly grep the folder to ensure no other file also usesweight: 130, otherwise ordering will be non-deterministic.docs/010-contribution-guidelines/contribution-flow.md (1)
2-3: Title/weight change LGTM.Renaming to Title Case and lowering the weight to 20 fits the new hierarchy.
docs/050-mentorship-program/asyncapi-mentorship/2024/README.md (1)
1-4: Metadata consistent; verify yearly weights remain monotonic.The 2024 file carries
weight: 60, which should sit after 2023 (50) and before 2025 (70+) if such files exist. Looks fine, just sanity-check sibling weights.docs/050-mentorship-program/seasonofdocs/2022/README.md (1)
1-4: Front-matter accepted.YAML syntax, casing, and incremental weight (70) all match the agreed pattern.
docs/000-onboarding/where-to-contribute.md (1)
1-4: Front-matter looks goodTitle and weight are consistent with the new hierarchy.
No further action required.docs/000-onboarding/maintainer-guide.md (1)
1-4: Weight 40 is unique in docs/000-onboarding
Thergsearch confirms that onlydocs/000-onboarding/maintainer-guide.mdusesweight: 40. No duplicates found—menu order remains unambiguous.docs/050-mentorship-program/summerofcode/2024/README.md (1)
1-4: Confirm sibling weights around 140The new entry comes in at
weight: 140. If 2023 is 130 and 2025 will be 150 this is perfect; otherwise verify the sequence to keep chronological order predictable.docs/050-mentorship-program/seasonofdocs/2023/README.md (1)
1-4: LGTM – front-matter added correctly
No issues spotted.docs/000-onboarding/ambassador-guide.md (1)
40-42: Relative link resolves correctlyThe target file
docs/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.mdexists, so the link in docs/000-onboarding/ambassador-guide.md (lines 40–42) resolves successfully. No changes are needed.docs/050-mentorship-program/asyncapi-mentorship/2023/README.md (1)
1-4: Weight sanity-checkWeight 50 keeps the chronological order (2022 → 40, 2023 → 50). Looks good.
docs/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)
1-4: Front-matter looks goodTitle and weight follow the pattern; no issues spotted.
docs/020-governance-and-policies/voting.md (1)
1-4: Front-matter is consistent with the new docs scheme
titleandweightalign with the 10-step convention adopted across the folder. No further changes required.docs/010-contribution-guidelines/prerequisite-knowledge.md (1)
2-3: Front-matter update looks good; just double-check weight collisionsThe title capitalization and YAML formatting are valid and the new
weight: 10fits the 10-step scheme.
Please run a quick scan to be sure no sibling file inside010-contribution-guidelines/already uses the same weight, otherwise ordering may become non-deterministic.docs/000-onboarding/upholding-code-of-conduct.md (1)
2-4: Weight reduction OK; verify internal link paths
weight: 70should position the doc earlier in the onboarding flow—nice.
While touching the front-matter, please confirm that the link in line 47 still points to a valid file (code_of_conduct/code-of-conduct-committee.md). A quick test revealed past typos around that folder name in the repo.docs/000-onboarding/docs-onboarding-checklist.md (1)
2-3: Capitalization + new weight LGTM; scan for duplicate weightsNo issues spotted with the YAML itself. Please just ensure no other doc in
000-onboarding/usesweight: 60, otherwise ordering clashes may arise.docs/010-contribution-guidelines/create-new-docs-directories.md (1)
2-3: Check updated weight order
weight: 120is higher than the previous 80. Make sure the new value still fits the intended learning flow of010-contribution-guidelineswhere weights climb in steps of 10. (Ex.: 110, 120, 130...).
No functional issue, just confirming ordering.docs/050-mentorship-program/README.md (1)
1-4: Front-matter looks goodValid YAML delimiters, unique title, and weight fit the new hierarchy.
|
Hey @bandantonio
|
|
@thulieblack The tricky part with this PR is that the community repo doesn't provide a way to preview how docs will be rendered on the website. To test it manually, I created a simple script that grabs community docs and syncs them into markdown/docs/community section of the website repo. After starting dev server, there were linting errors like this (mostly due to incorrect usage of html tags): I fixed all of them to get to the preview but I feel like before we push these changes into production, we need to add the same linting functionality to the community repo because after the Update latest Community documentation in the website GitHub Action pulls this change, the website build will likely fail. UPD: After thinking about this again, I believe, having a linter is good, but not crucial because once I fix all the linting errors and inconsistencies, people won't be adding new sections and files with complex html tags every day. So, we can add a document to style guide describing how to create a new section and format front matter so a new document will appear on the website. |
|
TODO: I also need to add index pages to every new section to act like landing pages because without them, the sections become unreachable and throw 404 errors |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (1)
20-38: Remove leftover merge-conflict artefacts and the duplicated list.
=======plus the second “Ideas list” block are classic merge markers that will be rendered verbatim and break the page layout (and any MD linter).-======= -### Ideas list - -Number | Idea | Area | Lead Mentor | Scope -:---:|---|:---:|:---:|--- -1 | [Enhancing Developer Experience in CLI](https://github.com/asyncapi/cli/issues/15) | AsyncAPI CLI | [Aayush Saini](https://github.com/AayushSaini101) | … -2 | [AI-Powered AsyncAPI Generator](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10505262) | … | … -3 | [Becoming a Maintainer of AsyncAPI Generator](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10520123) | … | … -4 | [Performance + Accessibility Improvement of website](https://github.com/asyncapi/website/issues/3186) | … | … -5 | [Migration of build + workflow scripts to typescript](https://github.com/asyncapi/website/issues/3187) | … | … -6 | [User Research + Usability Testing on the AsyncAPI Website](https://github.com/asyncapi/website/issues/529) | … | … -7 | [Holopin Design Project](https://github.com/asyncapi/community/issues/1306) | … | … -8 | [Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10540858) | … | … -9 | [Onboarding Contributor Guides](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10610947) | … | … -10 | [Implementation and integration of new layout for studio](https://github.com/asyncapi/studio/issues/634) | … | … -11 | [Path to Maintainership for the AsyncAPI React Project](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10811342) | … | … -12 | [Expand Community Docs](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10818908) | … | … -13 | [Technical Blog Posts on Integrating AsyncAPI with Kafka](https://github.com/orgs/asyncapi/discussions/1361#discussioncomment-10885096) | … | …
🧹 Nitpick comments (2)
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (2)
6-6: Spelling/grammar nitpick.
# Projects ideas→# Project ideasor# Projects
18-18: Minor Markdown formatting issue.Missing space before the first link:
VS Code AsyncAPI[asyncapi/vs-asyncapi-preview]→VS Code AsyncAPI [asyncapi/vs-asyncapi-preview]
Similarly, add a space before[EDAVisualiser].
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (46)
docs/000-onboarding/docs-onboarding-checklist.md(1 hunks)docs/000-onboarding/index.md(1 hunks)docs/000-onboarding/maintainer-guide.md(2 hunks)docs/000-onboarding/upholding-code-of-conduct.md(4 hunks)docs/010-contribution-guidelines/BOUNTY_PROGRAM.md(2 hunks)docs/010-contribution-guidelines/Become-maintainer-in-existing-project.md(3 hunks)docs/010-contribution-guidelines/code-contributor-guide.md(2 hunks)docs/010-contribution-guidelines/contribution-flow.md(3 hunks)docs/010-contribution-guidelines/conventional-commits.md(2 hunks)docs/010-contribution-guidelines/identifying-good-first-issues.md(2 hunks)docs/010-contribution-guidelines/tools-and-setup.md(2 hunks)docs/011-styleguide/content-buckets.md(1 hunks)docs/011-styleguide/index.md(1 hunks)docs/011-styleguide/version-control.md(2 hunks)docs/020-governance-and-policies/CHARTER.md(1 hunks)docs/020-governance-and-policies/GOVERNANCE.md(3 hunks)docs/020-governance-and-policies/PROJECT_FUNDING.md(1 hunks)docs/020-governance-and-policies/TSC_MEMBERSHIP.md(4 hunks)docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md(1 hunks)docs/020-governance-and-policies/WORKING_GROUPS.md(2 hunks)docs/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md(1 hunks)docs/020-governance-and-policies/donating-projects.md(1 hunks)docs/020-governance-and-policies/introduction-of-changes-to-spec.md(1 hunks)docs/020-governance-and-policies/voting.md(1 hunks)docs/030-project-vision-strategy-goals/2025_Community_Goals.md(2 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/2023/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(2 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(1 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/2025/asyncapi-gsoc-ideas-page.md(1 hunks)docs/050-mentorship-program/summerofcode/README.md(2 hunks)docs/050-mentorship-program/summerofcode/application-template.md(1 hunks)docs/050-mentorship-program/summerofcode/mentors-guideline.md(1 hunks)docs/050-mentorship-program/winterofcode/2023/README.md(1 hunks)docs/060-meetings-and-communication/docs-community.md(1 hunks)docs/COC-incident-resolution-procedures.md(3 hunks)docs/CODE_OF_CONDUCT_COMMITTEE.md(1 hunks)
✅ Files skipped from review due to trivial changes (20)
- docs/020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md
- docs/CODE_OF_CONDUCT_COMMITTEE.md
- docs/010-contribution-guidelines/identifying-good-first-issues.md
- docs/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
- docs/050-mentorship-program/summerofcode/mentors-guideline.md
- docs/020-governance-and-policies/CHARTER.md
- docs/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md
- docs/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
- docs/010-contribution-guidelines/conventional-commits.md
- docs/050-mentorship-program/summerofcode/2024/README.md
- docs/010-contribution-guidelines/tools-and-setup.md
- docs/050-mentorship-program/seasonofdocs/2023/README.md
- docs/060-meetings-and-communication/docs-community.md
- docs/050-mentorship-program/seasonofdocs/2023/project-ideas.md
- docs/000-onboarding/maintainer-guide.md
- docs/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md
- docs/020-governance-and-policies/donating-projects.md
- docs/010-contribution-guidelines/BOUNTY_PROGRAM.md
- docs/020-governance-and-policies/TSC_MEMBERSHIP.md
- docs/COC-incident-resolution-procedures.md
🚧 Files skipped from review as they are similar to previous changes (25)
- docs/020-governance-and-policies/voting.md
- docs/050-mentorship-program/seasonofdocs/2022/README.md
- docs/000-onboarding/index.md
- docs/050-mentorship-program/summerofcode/2023/README.md
- docs/050-mentorship-program/asyncapi-mentorship/2022/README.md
- docs/011-styleguide/content-buckets.md
- docs/011-styleguide/version-control.md
- docs/050-mentorship-program/asyncapi-mentorship/2024/README.md
- docs/020-governance-and-policies/PROJECT_FUNDING.md
- docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md
- docs/020-governance-and-policies/introduction-of-changes-to-spec.md
- docs/050-mentorship-program/summerofcode/2021/README.md
- docs/050-mentorship-program/winterofcode/2023/README.md
- docs/020-governance-and-policies/WORKING_GROUPS.md
- docs/011-styleguide/index.md
- docs/010-contribution-guidelines/Become-maintainer-in-existing-project.md
- docs/000-onboarding/docs-onboarding-checklist.md
- docs/010-contribution-guidelines/contribution-flow.md
- docs/030-project-vision-strategy-goals/2025_Community_Goals.md
- docs/020-governance-and-policies/GOVERNANCE.md
- docs/050-mentorship-program/summerofcode/application-template.md
- docs/050-mentorship-program/summerofcode/README.md
- docs/000-onboarding/upholding-code-of-conduct.md
- docs/050-mentorship-program/asyncapi-mentorship/README.md
- docs/010-contribution-guidelines/code-contributor-guide.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: 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`.
🔇 Additional comments (2)
docs/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md (2)
1-4: Front-matter looks good.YAML syntax is correct and follows the repo’s
title/weightconvention.
19-19: Verify relative link path.
../../../000-onboarding/docs-onboarding-checklist.mdshould resolve to
docs/000-onboarding/docs-onboarding-checklist.md. Please double-check the target file exists after the re-shuffle.
|
Yes, that will be good, we do need the index and _section.md for all the new folders following the same approach we have on the website https://github.com/asyncapi/website/tree/master/markdown/docs |
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (2)
docs/010-contribution-guidelines/index.md (1)
8-33: Replace emphasis with real headings for section blocksSame MD036 issue as above. Proper headings improve navigation, enable automatic ToC generation and keep linter green.
-**Getting Started** +## Getting Started + ... -**Development Workflow** +## Development Workflow + ... -**Content Creation** +## Content Creation + ... -**Advanced Contributions** +## Advanced Contributions + ... -**Leadership and Mentoring** +## Leadership and Mentoring +docs/020-governance-and-policies/index.md (1)
8-31: Use proper headings instead of bold textFive bold lines act as section headers; switch them to
##headings and leave a blank line afterwards to satisfy markdownlint and improve readability.-**Foundation and Structure** +## Foundation and Structure + ... -**Decision-Making Processes** +## Decision-Making Processes + ... -**Contribution and Change Management** +## Contribution and Change Management + ... -**Sustainability and Growth** +## Sustainability and Growth + ... -**Special Programs** +## Special Programs +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/010-contribution-guidelines/index.md(1 hunks)docs/020-governance-and-policies/index.md(1 hunks)docs/030-project-vision-strategy-goals/index.md(1 hunks)docs/040-guides/index.md(1 hunks)docs/050-mentorship-program/index.md(1 hunks)docs/060-meetings-and-communication/index.md(1 hunks)docs/070-marketing/index.md(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- docs/060-meetings-and-communication/index.md
- docs/050-mentorship-program/index.md
- docs/070-marketing/index.md
- docs/030-project-vision-strategy-goals/index.md
🧰 Additional context used
🧠 Learnings (4)
📓 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/010-contribution-guidelines/index.md (1)
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/020-governance-and-policies/index.md (1)
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/040-guides/index.md (1)
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`.
🪛 markdownlint-cli2 (0.17.2)
docs/010-contribution-guidelines/index.md
8-8: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
12-12: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
17-17: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/020-governance-and-policies/index.md
8-8: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
13-13: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
18-18: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
24-24: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
29-29: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/040-guides/index.md
8-8: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
11-11: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
|
@asyncapi/bounty_team |
|
@coderabbitai approve |
✅ Actions performedComments resolved. |
|
Okay, I see most changes implemented. I'll merge, let's see how it goes 🤞🏿 |
|
/rtm |
github-project-automation
bot
moved this from In Progress
to Completed
in Bounty Program
|
@bandantonio asyncapi/website#4268 we are still missing a coupe of things |
|
We are almost there, check the deploy details from Netlify https://app.netlify.com/projects/asyncapi-website/deploys/6880e8b47ee857000825f0bb |
4 participants
Description
AsyncAPI Community Updated Documentation Structure
This ASCII tree represents the new organized structure of the
docs/folder based on the weight-based hierarchy implemented for better navigation and learning progression:Key Improvements Made
1. Structured Hierarchy
2. Logical Learning Flow in 010-contribution-guidelines
3. Weight-Based Navigation
weightset to 5This structure provides a clear, logical progression for community members from initial onboarding through advanced contribution and leadership roles.
Related issue(s)
Resolves #1951
Next steps
Convert all broken GitHub URLs to relative paths to enhance consistency and ensure proper compatibility with GitHub preview
Summary by CodeRabbit