docs: webinar series initiative #1847
Conversation
iambami
requested review from
quetzalliwrites,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
|
please follow the appropriate Conventional Commits |
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
WalkthroughTwo new documentation files have been added to the marketing section. One introduces the AsyncAPI Webinar Series Initiative, outlining its goals, structure, and guidelines. The other provides a detailed planning template to organize individual webinars, covering objectives, logistics, promotional details, technical requirements, and preparation checklists. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
iambami
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: 0
🧹 Nitpick comments (5)
webinar_series_initiative.md (5)
7-10: Enhance Descriptor for InsightsOn lines 9–10, the phrase “gain deeper insights” could be strengthened. Consider using “gain in-depth insights” to deliver a more impactful message.
-As AsyncAPI continues to evolve, we recognize the need for more interactive and accessible learning opportunities. While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. +As AsyncAPI continues to evolve, we recognize the need for more interactive and accessible learning opportunities. While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain in-depth insights into the AsyncAPI ecosystem.🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider an alternative adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
32-37: Refine Bullet Point PhrasingThe bullet points in the “Benefits of the Webinar Series” section all begin with “For …”. Rephrasing these can improve the flow and readability. For example:
- - For Attendees: Learning, skill-building, and networking opportunities. - - For Speakers: Exposure, recognition, and a platform to share ideas. - - For the Community: A growing knowledge base, increased collaboration, and a more vibrant ecosystem. + - Attendees enjoy learning, skill-building, and networking opportunities. + - Speakers benefit from enhanced exposure, recognition, and a platform to showcase their ideas. + - The community gains an expanding knowledge base, improved collaboration, and a more vibrant ecosystem.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
40-40: Heading Formatting – Remove Trailing PunctuationThe heading “### For Hosts:” on line 40 ends with a colon, which is flagged by markdown lint. Removing it will ensure consistency with style guidelines.
-### For Hosts: +### For Hosts🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
42-42: Typo CorrectionIn the bullet under “For Hosts”, “familarized” is misspelled. It should be “familiarized”.
- - Get familarized with the hosting platform (Restream) + - Get familiarized with the hosting platform (Restream)
48-48: Heading Formatting – Remove Trailing PunctuationSimilarly, the heading “### For Guests:” on line 48 ends with a colon. Removing the colon will align the heading with markdown style guidelines.
-### For Guests: +### For Guests🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
48-48: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
webinar_series_initiative.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider an alternative adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
webinar_series_initiative.md
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
48-48: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (11)
webinar_series_initiative.md (11)
1-2: Great Title and OverviewThe title clearly sets the tone and purpose of the document. The use of a descriptive headline benefits readers immediately.
3-6: Clear Introduction SectionThe introduction succinctly communicates the initiative’s purpose and audience. The message is clear and engaging.
11-15: Well-Defined GoalsThe “Our goals include:” section is concise and clearly outlines the objectives of the webinar series.
16-23: Why You Should Attend is EffectiveThis section clearly communicates the benefits for attendees. The bullet points are direct and informative.
24-31: Compelling Call to SpeakThe “Why You Should Speak” section effectively encourages potential speakers by highlighting tangible benefits.
55-61: Solid Content Structure OutlineThe “Suggested Content Structure” section clearly lays out the webinar flow. The steps are well-organized and easy to follow.
62-78: Comprehensive Event ChecklistBoth the “Pre-Event” and “Post-Event” checklists are thorough and cover necessary logistics for a successful webinar.
79-87: Effective Potential Speakers SectionThe section on potential speakers communicates diversity in expertise and inclusivity effectively.
88-93: Strong Recap SectionThe recap of the first session is engaging, and the inclusion of a replay link adds great value for those who missed the live event.
94-100: Engaging ConclusionThe “What’s Next?” section does a great job of inviting ongoing participation and clearly calls the community to action.
1-100: Commit Message Best Practices ReminderWhile the document is well-structured and comprehensive, please ensure that future commit messages adhere to the Conventional Commits guidelines as recommended in previous discussions.
🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider an alternative adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
40-40: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
48-48: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
There was a problem hiding this comment.
Minor additions, but make sure that everyone who usually hosts the series reviews and approves the requirements. Also, it'll be nice to know which community/marketing goal the initiative aligns with and how frequently the series will be for consistency's sake.
webinar_series_initiative.md
Outdated
|
|
||
| The AsyncAPI Webinar Series is just getting started! Stay tuned for upcoming sessions, and if you have suggestions for topics or speakers, we’d love to hear from you. | ||
|
|
||
| Want to attend the next session? Follow our updates and turn on notifications! 📢 Interested in speaking? Reach out to us—we’d love to have you! |
There was a problem hiding this comment.
Where should they follow for updates? To whom are they reaching out, and how do they propose a topic?
webinar_series_initiative.md
Outdated
|
|
||
| ### Post-Event | ||
|
|
||
| - Share a recap blog post and recording. |
There was a problem hiding this comment.
Who will write the blog post? Recording I may understand
There was a problem hiding this comment.
Me! If it won’t be too much of a blog post. I plan to write a summary blog after each webinar. Do you advise otherwise? @thulieblack
webinar_series_initiative.md
Outdated
| ### Post-Event | ||
|
|
||
| - Share a recap blog post and recording. | ||
| - Gather feedback from attendees and speakers. |
There was a problem hiding this comment.
How will the feedback be gathered?
There was a problem hiding this comment.
The same way the previous one was gathered. From the attendees' comments on Youtube and on socials when it’s landed.
webinar_series_initiative.md
Outdated
| - Keep the session on time and moderate the Q&A effectively. | ||
| - Coordinate with the speaker in advance to understand their presentation flow. | ||
|
|
||
| ### For Guests: |
There was a problem hiding this comment.
Any recommended aspect ratio to be used? Guidelines on how to present the demo would be good. And mention how the demos should be visible
There was a problem hiding this comment.
yes aspect ratio for when they're presenting demos
Alright. |
|
@iambami any update here? |
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
webinar_series_initiative.md (1)
90-93: 🛠️ Refactor suggestionEnhance call-to-action: add LinkedIn link and fix typos
- Provide the actual AsyncAPI LinkedIn URL.
- Correct "subcribe" → "subscribe".
- Wrap URLs in angle brackets to prevent Markdown parsing issues.
-The AsyncAPI Webinar Series is just getting started! Stay tuned for upcoming sessions, and if you have suggestions for topics or speakers, [we’d love to hear from you](https://join.slack.com/t/asyncapi/shared_invite/zt-32hejdicx-NrD~boRq71gpCBJAM8mFoA). +The AsyncAPI Webinar Series is just getting started! Stay tuned for upcoming sessions, and if you have suggestions for topics or speakers, [we’d love to hear from you](<https://join.slack.com/t/asyncapi/shared_invite/zt-32hejdicx-NrD~boRq71gpCBJAM8mFoA>). -Want to attend the next session? Follow our updates on LinkedIn, [subcribe to our YouTube page and turn on notifications!](https://www.youtube.com/@AsyncAPI) Interested in speaking? Reach out to us, we’d love to have you! +Want to attend the next session? Follow our updates on LinkedIn at <https://www.linkedin.com/company/asyncapi/>, subscribe to our YouTube page and turn on notifications: <https://www.youtube.com/@AsyncAPI>. Interested in speaking? Reach out to us, we’d love to have you!
♻️ Duplicate comments (1)
webinar_series_initiative.md (1)
5-6: Introduction follows previously suggested copy
The introduction mirrors the wording recommended by @TRohit20 and effectively sets the tone for the initiative. Well done.
🧹 Nitpick comments (2)
webinar_series_initiative.md (2)
9-10: Consider strengthening the adjective in the key sentence
The phrase "gain deeper insights" is clear, but you might consider a stronger adjective for impact (e.g., "gain profound insights").-While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. +While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain profound insights into the AsyncAPI ecosystem.🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
48-54: Improve guest guidelines with aspect ratio recommendation
- Remove trailing colon in the guest heading.
- Suggest including a recommended aspect ratio for demos to address display consistency.
-### For Guests: +### For Guests - Prepare slides or a live demo that fits the topic. +- Prepare slides or a live demo that fits the topic. +- Ensure slides and demos are in a 16:9 aspect ratio for optimal viewing.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
48-48: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
webinar_series_initiative.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
webinar_series_initiative.md
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
48-48: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
|
@AceTheCreator @TRohit20 your review |
|
Hey @AceTheCreator, @thulieblack, and @TRohit20, please give your final review. |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
webinar_series_initiative.md (1)
1-1: Title consistency verified.
The document title now matches the file name and PR objective, including “Series” for clarity.
🧹 Nitpick comments (3)
webinar_series_initiative.md (3)
9-9: Consider stronger adjective to replace “deeper.”
To enhance impact, you might substitute “gain deeper insights” with a more vivid phrase, such as “gain comprehensive insights” or “gain in-depth insights.”🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
75-76: Specify feedback collection method.
To close the feedback loop, clarify how feedback will be gathered (e.g., via a survey link, Slack poll, YouTube comments). For example:- [ ] Gather feedback from attendees and speakers via a post-event survey (e.g., Google Forms or Typeform) and Slack channel poll.
90-93: Fix typo and add LinkedIn link.
- Correct “subcribe” → “subscribe.”
- Provide the LinkedIn updates link for consistency.
Example diff:-Want to attend the next session? Follow our updates on LinkedIn, [subcribe to our YouTube page and turn on notifications!](https://www.youtube.com/@AsyncAPI) +Want to attend the next session? Follow our updates on [LinkedIn](https://www.linkedin.com/company/asyncapi/) and [subscribe to our YouTube channel](https://www.youtube.com/@AsyncAPI) to turn on notifications!
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
webinar_series_initiative.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
webinar_series_initiative.md (1)
5-6: Intro paragraph well-aligned with community vision.
The opening succinctly captures the AsyncAPI community’s collaborative spirit and clearly introduces the webinar series.
|
@iambami please update the pr with the pending reviews |
There was a problem hiding this comment.
This looks great, @iambami! 💜
One thing I noticed is that the documentation doesn’t explicitly outline the process for aligning the host and speakers.
It might be helpful to have a dedicated step where the host and speakers connect ahead of the webinar to align on its objectives and key results.
We could also consider creating a webinar planning template that can be easily shared with both parties. This would help streamline communication and ensure everyone is on the same page before the session.
Let me know what you think.
Hmmmm... Thanks for the suggestions. I can work on that. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
webinar_series_initiative.md (4)
9-9: Avoid repetitive adjectives for stronger prose
Consider replacing "gain deeper insights" with a different adjective (e.g., "gain further insights") to strengthen the wording.🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
47-47: Clarify webinar frequency criteria
The phrase "monthly or bi-monthly based on availability" could be made more actionable by specifying how the cadence is decided or any fallback schedule. Please confirm the decision criteria for switching between monthly and bi-monthly.
87-91: Add technical guidelines for host video setup
To ensure demos are visible and consistent, include a bullet under "For Hosts" recommending video settings (e.g., 16:9 aspect ratio at 1080p, proper lighting, screen capture tools).
129-135: Specify outreach channel for potential speakers
The "reach out to us" call-to-action in "Potential Speakers" is ambiguous. Please add a link or contact method (e.g., Slack channel or email) so interested speakers know exactly where to propose topics.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
webinar_series_initiative.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
webinar_series_initiative.md (1)
1-2: Title aligns with PR objective and file name
The document title correctly includes "Webinar Series" matching the file name and PR description.
|
Please give it another look. I'm also contemplating leaving the webinar planning template as a document or a Google Form. You can go through this and let me know. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
webinar_series_initiative.md (7)
7-15: Link Goals to Strategic Community ObjectivesConsider explicitly mapping these goals to AsyncAPI’s broader community or marketing objectives (e.g., driving Slack engagement, increasing YouTube subscriptions, or meeting content KPIs) to demonstrate how success will be measured.
🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
47-48: Clarify Webinar Frequency“Monthly or bi-monthly based on availability and demand” may introduce scheduling ambiguity. Define a default cadence (e.g., monthly) with clear guidelines for exceptions to ensure consistency.
81-83: Validate Planning Template Link AccessibilityEnsure the shared Google Doc link has appropriate view/edit permissions for hosts and speakers to avoid access issues. If needed, switch to a view-only link or clarify access instructions.
85-89: Refine Host Preparation Wording“Get familiarized with the hosting platform (Restream)” reads a bit formal; consider “Get familiar with the hosting platform (Restream)” for conciseness.
122-124: Specify Blog Post OwnershipThe post-event checklist includes “Share a recap blog post and recording” but lacks an owner. Indicate who is responsible for drafting and publishing the recap (e.g., AsyncAPI marketing lead, hosting speaker, or rotating contributor).
123-125: Detail Feedback Collection ChannelsAdd how to gather feedback (e.g., via YouTube comments, Slack surveys, or post-webinar forms) to ensure structured and actionable insights.
139-142: Reformat “What’s Next?” for ClarityConvert this paragraph into bullet points to improve scannability:
- Follow our updates on LinkedIn. - Subscribe to our YouTube channel and turn on notifications. - Interested in speaking? Reach out to us via Slack.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
webinar_series_initiative.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
webinar_series_initiative.md (1)
1-2: Title Alignment and ClarityThe document title matches the file name and PR objective, clearly conveying the initiative's scope and focus.
|
|
||
| ## Format Guidelines for Host & Guest | ||
|
|
||
| Before the live session, hosts and guests should schedule a short planning call and fill out the [webinar planning template](https://docs.google.com/document/d/1uiEB3Fq2XE7rbnYqlgMr4_b1bvi4dMQj95wln3z3-qg/edit?tab=t.0) to align on goals, presentation flow, and audience engagement strategies. |
There was a problem hiding this comment.
Rather create an .md doc with these instructions under the folder and not a google doc!
|
Okay. |
for the Google doc file. Is the .md file going to be separate from the current file? Does that mean a new PR or on this same PR @thulieblack PS: I thought I'd sent this message since 3 weeks ago. |
Yes, it will be the same way you have it now. The only difference is that the meeting instructions will be in .md format instead of a Google Doc. So, you need to add a new doc under this same PR. |
Alright. |
|
Hey @thulieblack I've implemented the changes. Although I realized I need a Google Drive link for the speakers headshots. Thank you. |
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
docs/070-marketing/webinar_planning_template.md (1)
46-60: Add a blank line after the checklist block for graceful EOF handlingSome Markdown processors (MkDocs, Gatsby) complain when a file ends directly after a list item. Add a trailing newline to avoid rendering glitches.
-Notes: +Notes: +docs/070-marketing/ webinar_series_initiative.md (1)
143-145: Remove trailing colon in the “Disclaimer” heading to satisfy MD026-## Disclaimer: +## Disclaimer
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/070-marketing/ webinar_series_initiative.md(1 hunks)docs/070-marketing/webinar_planning_template.md(1 hunks)
🧰 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/070-marketing/ webinar_series_initiative.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`.
🪛 LanguageTool
docs/070-marketing/ webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
docs/070-marketing/ webinar_series_initiative.md
143-143: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
docs/070-marketing/webinar_planning_template.md
16-16: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
| - Session Goals (What should attendees leave with?): | ||
| - Key Talking Points / Agenda: | ||
| - Point 1: | ||
| - Point 2: | ||
| - Point 3: | ||
| - Target Audience: (beginner, intermediate, advanced, etc.) |
There was a problem hiding this comment.
Fix nested-list indentation to satisfy Markdown style rules
markdownlint flags MD007 because the sub-points under “Key Talking Points / Agenda” are indented with 4 spaces instead of 2. This will render fine on GitHub but breaks many docs generators and fails CI if linting is enforced.
- Key Talking Points / Agenda:
- - Point 1:
- - Point 2:
- - Point 3:
+ Key Talking Points / Agenda:
+ - Point 1:
+ - Point 2:
+ - Point 3:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Session Goals (What should attendees leave with?): | |
| - Key Talking Points / Agenda: | |
| - Point 1: | |
| - Point 2: | |
| - Point 3: | |
| - Target Audience: (beginner, intermediate, advanced, etc.) | |
| - Session Goals (What should attendees leave with?): | |
| - Key Talking Points / Agenda: | |
| - Point 1: | |
| - Point 2: | |
| - Point 3: | |
| - Target Audience: (beginner, intermediate, advanced, etc.) |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
16-16: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In docs/070-marketing/webinar_planning_template.md around lines 14 to 19, the
nested list items under "Key Talking Points / Agenda" are indented with 4 spaces
instead of the required 2 spaces for proper Markdown style. Fix this by reducing
the indentation of the sub-points from 4 spaces to 2 spaces to comply with
markdownlint MD007 and ensure compatibility with all docs generators and CI
linting.
| @@ -0,0 +1,145 @@ | |||
| # AsyncAPI Webinar Series Initiative: Learning, Sharing, and Growing Together | |||
There was a problem hiding this comment.
Remove the leading space in the filename
The path docs/070-marketing/ webinar_series_initiative.md contains a prefixed space, producing %20 in URLs and breaking every link or import that targets the document. Rename to:
docs/070-marketing/webinar_series_initiative.md
and update all references accordingly.
🤖 Prompt for AI Agents
In docs/070-marketing/ webinar_series_initiative.md at line 1, the filename
contains a leading space after the slash, causing URL encoding issues and broken
links. Rename the file to remove the space so it becomes
docs/070-marketing/webinar_series_initiative.md, and update all references to
this file throughout the project to match the corrected filename.
| Before the live session, hosts and guests should schedule a short planning call and fill out the [webinar planning template](https://docs.google.com/document/d/1uiEB3Fq2XE7rbnYqlgMr4_b1bvi4dMQj95wln3z3-qg/edit?tab=t.0) to align on goals, presentation flow, and audience engagement strategies. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace hard-coded Google Doc link with the local Markdown template
Now that webinar_planning_template.md lives in the repo, point readers to the canonical source to keep everything self-contained and editable via PRs.
-Before the live session, hosts and guests should schedule a short planning call and fill out the [webinar planning template](https://docs.google.com/document/d/1uiEB3Fq2XE7rbnYqlgMr4_b1bvi4dMQj95wln3z3-qg/edit?tab=t.0) to align on goals, presentation flow, and audience engagement strategies.
+Before the live session, hosts and guests should schedule a short planning call and fill out the [webinar planning template](./webinar_planning_template.md) to align on goals, presentation flow, and audience engagement strategies.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Before the live session, hosts and guests should schedule a short planning call and fill out the [webinar planning template](https://docs.google.com/document/d/1uiEB3Fq2XE7rbnYqlgMr4_b1bvi4dMQj95wln3z3-qg/edit?tab=t.0) to align on goals, presentation flow, and audience engagement strategies. | |
| Before the live session, hosts and guests should schedule a short planning call and fill out the [webinar planning template](./webinar_planning_template.md) to align on goals, presentation flow, and audience engagement strategies. |
🤖 Prompt for AI Agents
In docs/070-marketing/webinar_series_initiative.md around lines 83 to 84,
replace the hard-coded Google Doc URL with a relative link to the local markdown
file webinar_planning_template.md in the repository. This change ensures the
document references the canonical source within the repo, making it easier to
maintain and update via pull requests.
Hello everyone 👋
Given our discussion, here is a draft of the webinar series initiative.
Go through it and drop your reviews.
cc/ @derberg @thulieblack @TRohit20 @AceTheCreator
Summary by CodeRabbit