Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Mar 27, 2025

Updated community documentation is available and this PR introduces update to community folder on the website

Summary by CodeRabbit

  • Documentation
    • Updated the community onboarding guide by removing bold formatting from section headers while keeping the content intact.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 27, 2025

Walkthrough

This pull request updates the maintainer onboarding guide by removing bold formatting from several section headers. The affected headers include steps such as "Pick an Issue," "Open a PR," "Get your PR merged," and "Receive an invitation to become a Maintainer 🎉." The content and structure of the guide remain unchanged, with only the formatting adjusted for a cleaner visual presentation.

Changes

File Change Summary
markdown/docs/.../maintainer-guide.md Removed bold formatting from section headers in various onboarding steps.

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • TRohit20
  • Aahil13
  • VaishnaviNandakumar
  • asyncapi-bot-eve

Poem

I'm a rabbit with a tiny smile,
Hopping through docs mile by mile.
Bold fonts gone without a trace,
Clean headers now embrace the space.
In this guide, the words dance free—
A hoppy update for you and me!
🐰🎉


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c51a00c and f84d4a7.

📒 Files selected for processing (1)
  • markdown/docs/community/onboarding-guide/maintainer-guide.md (3 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (5)
  • GitHub Check: Redirect rules - asyncapi-website
  • GitHub Check: Header rules - asyncapi-website
  • GitHub Check: Pages changed - asyncapi-website
  • GitHub Check: Automerge PR autoapproved by a bot
  • GitHub Check: Lighthouse CI
🔇 Additional comments (4)
markdown/docs/community/onboarding-guide/maintainer-guide.md (4)

36-36: Updated Header Formatting for "1. Pick an Issue"
The bold formatting has been removed from the "1. Pick an Issue" header, aligning it with the updated visual style for the guide. This change improves consistency across section headers while preserving the hierarchical structure.


47-47: Consistent Header Styling for "2. Open a PR"
The "2. Open a PR" header now appears in plain markdown without bold formatting, which enhances readability and maintains consistency with the other section headers.


59-59: Refined Header Appearance for "3. Get your PR merged"
The updated "3. Get your PR merged" header follows the new styling conventions by removing bold emphasis. This creates a cleaner and more uniform look throughout the document.


67-67: Streamlined Header for "4. Receive an invitation to become a Maintainer 🎉"
The header now consistently uses plain markdown formatting without bold styling while retaining the celebratory emoji, which aligns well with the overall documentation update.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

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

Other keywords and placeholders

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

Documentation and Community

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

@netlify
Copy link

netlify bot commented Mar 27, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 0e2643e
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67e6417421bbf300080cf261
😎 Deploy Preview https://deploy-preview-3983--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e86c3c6) to head (0e2643e).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3983   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines          667       667           
  Branches       113       113           
=========================================
  Hits           667       667           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 29b2fa1 into master Mar 28, 2025
19 of 20 checks passed
@asyncapi-bot asyncapi-bot deleted the update-community-docs-1b100556f2d873477bc48dc1af3ad1c60789db31 branch March 28, 2025 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants