chore(docs): clean up mentorship guide #2106
Conversation
AceTheCreator
requested review from
asyncapi-bot-eve,
bandantonio,
derberg and
thulieblack
as code owners
WalkthroughConsolidates and restructures mentorship documentation: several READMEs removed, project-ideas pages expanded into detailed completed-project entries, new insights metrics page added, hub/index content rewritten, and multiple GSoC idea pages added or standardized. No code changes. Changes
Sequence Diagram(s)(No sequence diagrams provided — changes are documentation-only and do not modify control flow or runtime interactions.) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/050-mentorship-program/asyncapi-mentorship-README.md (1)
1-8: Fix broken cross-reference at line 79.The link to
./asyncapi-mentorship-2025-READMEdoes not exist. The file listing shows project idea files only for 2022, 2023, and 2024 (asyncapi-mentorship-202X-project-ideas.md). Update line 79 to reference an existing file (e.g.,./asyncapi-mentorship-2024-project-ideas) or create the 2025 file if the program cycle has started.The static analysis heading-level flag is a false positive; the heading hierarchy is correct (h1 → h2 → h3 progression), and line 8 contains intro text, not a heading. The
./insightsreference is valid.
🧹 Nitpick comments (2)
docs/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md (2)
206-206: Use hyphen for compound adjective "drag-and-drop."Line 206 uses "drag and drop" as a compound adjective modifying "blocks"; it should be "drag-and-drop" for grammatical correctness.
Apply this diff:
-Add the ability to create AsyncAPI specifications from scratch (or update existing ones) using drag and drop blocks in Studio, similar to the current read-only visualizer. +Add the ability to create AsyncAPI specifications from scratch (or update existing ones) using drag-and-drop blocks in Studio, similar to the current read-only visualizer.
80-80: Minor: Consider rephrasing for clarity.Line 80 uses "hard to get started"; this phrasing could be strengthened. Consider alternatives like "challenging" or "difficult" for more precise technical documentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (16)
docs/050-mentorship-program/asyncapi-mentoring-initiatives.md(0 hunks)docs/050-mentorship-program/asyncapi-mentorship-2022-README.md(0 hunks)docs/050-mentorship-program/asyncapi-mentorship-2022-project-ideas.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship-2023-README.md(0 hunks)docs/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship-2024-README.md(0 hunks)docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md(1 hunks)docs/050-mentorship-program/asyncapi-mentorship-README.md(1 hunks)docs/050-mentorship-program/index.md(1 hunks)docs/050-mentorship-program/insights.md(1 hunks)docs/050-mentorship-program/summerofcode-2023-README.md(0 hunks)docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md(1 hunks)docs/050-mentorship-program/summerofcode-2024-README.md(0 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(2 hunks)docs/050-mentorship-program/summerofcode-README.md(2 hunks)
💤 Files with no reviewable changes (6)
- docs/050-mentorship-program/asyncapi-mentorship-2024-README.md
- docs/050-mentorship-program/asyncapi-mentorship-2023-README.md
- docs/050-mentorship-program/asyncapi-mentoring-initiatives.md
- docs/050-mentorship-program/summerofcode-2023-README.md
- docs/050-mentorship-program/summerofcode-2024-README.md
- docs/050-mentorship-program/asyncapi-mentorship-2022-README.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: bandantonio
PR: asyncapi/community#2011
File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19
Timestamp: 2025-07-28T23:09:06.895Z
Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
📚 Learning: 2025-07-28T23:09:06.895Z
Learnt from: bandantonio
PR: asyncapi/community#2011
File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19
Timestamp: 2025-07-28T23:09:06.895Z
Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
Applied to files:
docs/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.mddocs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.mddocs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.mddocs/050-mentorship-program/asyncapi-mentorship-2022-project-ideas.md
🪛 LanguageTool
docs/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md
[style] ~80-~80: To elevate your writing, try using a synonym here.
Context: ...ation, and deployment. Currently, it is hard to get started with Glee as a new user....
(HARD_TO)
[grammar] ~206-~206: Use a hyphen to join words.
Context: ...tch (or update existing ones) using drag and drop blocks in Studio, similar to th...
(QB_NEW_EN_HYPHEN)
[grammar] ~206-~206: Use a hyphen to join words.
Context: ...(or update existing ones) using drag and drop blocks in Studio, similar to the cu...
(QB_NEW_EN_HYPHEN)
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md
[style] ~80-~80: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...plates etc. The endpoint should be done in a similar way as in our main CLI, so the main help en...
(IN_A_X_MANNER)
docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md
[grammar] ~78-~78: Ensure spelling is correct
Context: ...Length:** 350 Hours ## 7) [Integrating EDAVisualiser Application Focus View into VS Code Asy...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~80-~80: Ensure spelling is correct
Context: ...e the VS Code AsyncAPI Plugin by adding EDAVisualiser's application focus view. This new featur...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~80-~80: 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/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md
[uncategorized] ~91-~91: The official name of this software platform is spelled with a capital “H”.
Context: ...(https://github.com/14Richa)** in our .github, ...
(GITHUB)
docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
[uncategorized] ~56-~56: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ensions, Spectral Linting, Testing, and Open Source Contribution. - 🧩 Difficulty: Medi...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~76-~76: The official name of this software platform is spelled with a capital “H”.
Context: ... Required:** Typescript, Node js, Jest, Github actions - 🧩 Difficulty: Medium/Har...
(GITHUB)
[uncategorized] ~86-~86: The official name of this software platform is spelled with a capital “H”.
Context: ...ed:** Typescript, Node js, E2E Testing, Github actions - 🧩 Difficulty: Medium/Har...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md
32-32: Bare URL used
(MD034, no-bare-urls)
51-51: Bare URL used
(MD034, no-bare-urls)
69-69: Bare URL used
(MD034, no-bare-urls)
82-82: Bare URL used
(MD034, no-bare-urls)
docs/050-mentorship-program/index.md
8-8: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
docs/050-mentorship-program/asyncapi-mentorship-README.md
8-8: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
docs/050-mentorship-program/summerofcode-README.md
8-8: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (14)
docs/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md (2)
237-237: FAQ reference to new insights page is well-placed.The FAQ references the new "Mentorship Programs Insights" page with retention statistics, which aligns with the PR objective to add comprehensive program metrics. This cross-reference enhances discoverability.
6-8: Clarify completion status for projects 11-21.The page header declares "Status: Completed," but projects 11-21 lack mentee assignments and completion markers (✅), while projects 1-10 have both. Projects 11 and onward contain no mentee assignments (project 11 has mentors but no mentees; projects 12-21 lack both). This inconsistency creates ambiguity about whether the entire 2023 program was completed or only partially. Please clarify the intent: are projects 11-21 unassigned proposals, cancelled initiatives, incomplete entries, or should the status be revised to "Partially Completed"?
docs/050-mentorship-program/asyncapi-mentorship-2022-project-ideas.md (1)
113-152: Verify completeness of mentee assignments in projects 10–13.Projects 10 through 13 lack mentee assignments while earlier projects (1–9) all include mentee names and GitHub links. Projects 1–9 are marked with ✅ completion indicators, but projects 10–13 lack these markers. Given this is a completed 2022 program, clarify whether:
- These projects were not completed or assigned during the program, or
- The mentee data is incomplete in the archival record.
If projects 10–13 were completed, add mentee assignments for consistency. If they were not completed, consider adding a note to explain their status.
docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md (2)
100-149: Clarify mentee assignments for projects 9, 10, 11, and 13.Four projects lack mentee assignments while maintaining all other metadata fields and ✅ completion markers:
- Project 9 (AI-Powered Generator) – mentor assigned, no mentee
- Project 10 (Performance + Accessibility) – mentor assigned, no mentee
- Project 11 (User Research) – mentor assigned, no mentee
- Project 13 (Blog Posts) – mentor assigned, no mentee
For consistency with the 8 other projects in this program, either add mentee assignments or explicitly document why these projects lack mentee information (e.g., unfilled roles at archive time). If these projects were mentee-less by design, consider adding a note to clarify.
6-8: Update FAQ cross-reference to reflect insights page availability.Line 166 references the new Mentorship Programs Insights page for retention statistics, which aligns well with this restructured documentation. Ensure this reference is accurate and the insights page is discoverable from the main mentorship hub (index.md).
docs/050-mentorship-program/index.md (3)
21-30: Verify all referenced program pages exist and links are accurate.The "Available Programs" table (lines 23–30) references several program pages with relative links:
./asyncapi-mentorship-README./summerofcode-README./seasonofdocs-2023-README./winterofcode-2023-README./openforce/README./hacktoberfest/READMEConfirm these files exist at the specified paths and are correctly accessible from the mentorship program directory. If any of these programs have been archived or removed, update the table to reflect current status.
60-62: Validate success stories data accuracy and consistency.The "Success Stories" section highlights three examples of mentee-to-mentor transitions with GitHub handles and years active. Cross-reference these names against the detailed mentee-to-mentor transition data in the new insights.md page (e.g., line 70-77 in insights.md) to ensure consistency and accuracy.
Additionally, verify the statements about "50% overall retention rate" (line 56) and other statistics align with the detailed metrics provided in insights.md.
10-10: Fix heading hierarchy violation (MD001).Line 10 creates a heading jump from h1 (#) on line 6 directly to h3 (###), violating Markdown lint rule MD001 (heading-increment). This should be h2 (##) instead:
-## Get Help & Support +## Get Help & Support(Note: The content is already correct; this may be a rendering or display issue in the annotation. Please verify the actual heading level in the file.)
Likely an incorrect or invalid review comment.
docs/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md (1)
6-83: Comprehensive GSoC 2024 project documentation – well-structured and complete.This page successfully documents 7 completed GSoC 2024 projects with consistent formatting, complete mentee assignments, clear status indicators (✅), and detailed metadata (outcomes, skills, difficulty, hours). The program status banner and completion note are clear. The FAQ provides helpful context about previous participation and AI tool usage policies.
docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md (1)
12-101: Clarify ✅ checkmark usage for "made it to final" projects.The header note (line 12) states "Projects with checkboxes are project that made it to the final," but checkmark usage is inconsistent:
- Projects 1-2 lack ✅ (CLI Performance, AI Assistant)
- Projects 3-9 have ✅ (Generator Maintainership through Website Redesign)
This is confusing for readers. Either:
- Add ✅ to projects 1-2 if they also made it to final, or
- Clarify in the header note that only projects 3-9 made the final selection
Additionally, note a potential typo at line 99: "Guptap" should likely be "Gupta" to match the mentor name format.
docs/050-mentorship-program/insights.md (2)
1-150: Comprehensive mentorship insights documentation – well-researched and impactful.This new insights page provides valuable quantitative context for the AsyncAPI mentorship programs with strong data-driven narratives. Key strengths:
- Clear retention metrics showing 50% overall retention (double industry standard)
- Breakdown by program type and year reveals improving retention trends
- Mentee-to-mentor pipeline table demonstrates program sustainability
- Active contributors sections with expandable details enhance discoverability
- "Key Insights" summary provides accessible takeaways
- Data currency note (October 2025) provides appropriate transparency
This page effectively complements the restructured program pages and provides the quantitative context referenced throughout the mentorship documentation.
14-18: Verify cross-file consistency of metrics and mentor/mentee names.Cross-check the retention statistics and mentee-to-mentor transition data in this insights file against:
- Individual program project-ideas pages (2022, 2023, 2024, GSoC 2023-2025) to ensure mentee counts and active contributor lists match
- The success stories section in index.md (lines 60 in index.md) to ensure consistency in named examples
Given that this insights page references specific individuals and years, a data integrity check would strengthen confidence in these metrics.
Also applies to: 48-51
docs/050-mentorship-program/asyncapi-mentorship-README.md (2)
79-79: Verify the 2025 program link status.Line 79 references
./asyncapi-mentorship-2025-READMEin the "How to Apply" section, but the Program Cycles table (lines 33–37) only lists 2024, 2023, and 2022 programs as completed. Clarify whether this is a forward-looking placeholder, a file that should exist in this PR, or if the link should point to a different year.
8-244: Excellent restructuring and comprehensive content updates.The refactoring significantly improves the document's accessibility and readability. The addition of Program Statistics (with retention/conversion metrics), Success Stories demonstrating mentee-to-mentor progression, and a structured FAQ section all strengthen the guide. The reorganization into clear sections for mentees, mentors, and administration creates a logical flow that's easy to navigate.
The new Program Leadership section with contact information and the detailed Evaluation Process are particularly valuable. The program goals and definitions are clearly articulated, making expectations transparent for all participants.
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md
Outdated
Show resolved
Hide resolved
docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
Outdated
Show resolved
Hide resolved
docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md (1)
80-80: Consider rephrasing for conciseness.The phrase "should be done in a similar way as in our main CLI" is verbose. Simplify to: "should be done similarly to our main CLI."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md(1 hunks)docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md(2 hunks)docs/050-mentorship-program/summerofcode-README.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/050-mentorship-program/summerofcode-README.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-28T23:09:06.895Z
Learnt from: bandantonio
PR: asyncapi/community#2011
File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19
Timestamp: 2025-07-28T23:09:06.895Z
Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
Applied to files:
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md
🪛 LanguageTool
docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
[uncategorized] ~56-~56: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ensions, Spectral Linting, Testing, and Open Source Contribution. - 🧩 Difficulty: Medi...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~76-~76: The official name of this software platform is spelled with a capital “H”.
Context: ... Required:** Typescript, Node js, Jest, Github actions - 🧩 Difficulty: Medium/Har...
(GITHUB)
[uncategorized] ~86-~86: The official name of this software platform is spelled with a capital “H”.
Context: ...ed:** Typescript, Node js, E2E Testing, Github actions - 🧩 Difficulty: Medium/Har...
(GITHUB)
docs/050-mentorship-program/summerofcode-2023-asyncapi-gsoc-ideas-page.md
[style] ~80-~80: Consider replacing this phrase with the adverb “similarly” to avoid wordiness.
Context: ...plates etc. The endpoint should be done in a similar way as in our main CLI, so the main help en...
(IN_A_X_MANNER)
🔇 Additional comments (1)
docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md (1)
90-90: Standardize hours capitalization for consistency.Line 90 uses "175 hours" (lowercase), while line 100 uses "350 hours" (lowercase as well). However, reviewing earlier entries (lines 22, 30, 40, 50, 60, 70, 80), they all use "⏳ Length: X Hours" with capital H. Standardize line 90 to match:
-⏳ **Length:** 175 hours +⏳ **Length:** 175 Hours
|
|
||
| Welcome to the **AsyncAPI Ideas Page** with our proposed projects for Google Summer of Code (GSoC) 2025! If you are an interested contributor, please don't hesitate to contact our mentors directly to discuss project ideas. | ||
|
|
||
| > Note: Projects with checkboxes are project that made it to the final. |
There was a problem hiding this comment.
Fix grammar: plural mismatch.
Line 12 reads: "Projects with checkboxes are project that made it to the final." This should be: "Projects with checkboxes are projects that made it to the final."
🤖 Prompt for AI Agents
In docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
around line 12, fix the grammatical plural mismatch in the sentence "Projects
with checkboxes are project that made it to the final." by changing "project" to
"projects" so the sentence reads "Projects with checkboxes are projects that
made it to the final." Ensure only that word is updated and preserve surrounding
punctuation and capitalization.
| Add the script execution to a new folder inside the website, and add integration tests for those scripts. | ||
|
|
||
| - 🎯 **Outcome:** A full Unit + Integration tests setup will be added for the scripts to fully test the functionalities | ||
| - 🛠️ **Skills Required:** Typescript, Node js, Jest, Github actions |
There was a problem hiding this comment.
Standardize GitHub capitalization.
Lines 76 and 86 use "Github actions" but the correct product name is "GitHub actions" (with capital H).
Apply this diff:
-🛠️ **Skills Required:** Typescript, Node js, Jest, Github actions
+🛠️ **Skills Required:** Typescript, Node js, Jest, GitHub actions-🛠️ **Skills Required:** Typescript, Node js, E2E Testing, Github actions
+🛠️ **Skills Required:** Typescript, Node js, E2E Testing, GitHub actionsAlso applies to: 86-86
🧰 Tools
🪛 LanguageTool
[uncategorized] ~76-~76: The official name of this software platform is spelled with a capital “H”.
Context: ... Required:** Typescript, Node js, Jest, Github actions - 🧩 Difficulty: Medium/Har...
(GITHUB)
🤖 Prompt for AI Agents
In docs/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md
around lines 76 and 86, the product name "Github actions" is incorrectly
capitalized; update both occurrences to "GitHub actions" to match the correct
branding and spelling.
|
/rtm |
3 participants
Now that the community docs are being published on the website, I took the opportunity to refine the mentorship section to make it more readable and accessible. This update primarily focuses on improving the documentation for both the Google Summer of Code and AsyncAPI Mentorship programs.
Impact
This refactor elevates our mentorship documentation from simple tables to simply to functional and readable format.
Files Changed
mentorship/README.md– Main overview pagementorship/insights.md– New insights page (NEW)mentorship/asyncapi-mentorship-*.md– 2022, 2023, 2024 programsmentorship/summerofcode-*.md– GSoC 2023, 2024, 2025 programsSummary by CodeRabbit