community icon indicating copy to clipboard operation
community copied to clipboard

docs: #1762 Added the community info and links to documentation guides and removed the sponsor part.

Open Sonalilipsa17375 opened this issue 10 months ago • 4 comments

Description

  • Added Community links .
  • Provided guide to Docs contribution links.
  • Removed Sponsor part as suggested.

Before - >>

Screenshot From 2025-03-06 20-52-37

After - >>

Screenshot From 2025-03-13 17-52-25 Screenshot From 2025-03-13 17-52-53 Screenshot From 2025-03-13 17-53-06 Screenshot From 2025-03-13 17-53-21 Screenshot From 2025-03-13 17-53-37 Screenshot From 2025-03-13 17-54-58

fixes: #1762

Related issue(s) - Link to the issue - #1762

Sonalilipsa17375 avatar Mar 06 '25 15:03 Sonalilipsa17375

@thulieblack I made the changes as suggested by you in #1762 , Could you please let me know if any improvement is needed .

Sonalilipsa17375 avatar Mar 07 '25 16:03 Sonalilipsa17375

@thulieblack Can you pls rereview it, I have incorporated the changes you have suggested and also made many design changes.

Sonalilipsa17375 avatar Mar 13 '25 12:03 Sonalilipsa17375

Hey @thulieblack, Hope you're doing well! Just a gentle nudge on my PR whenever you find time. No rush, and thanks in advance! 😊

Sonalilipsa17375 avatar Mar 18 '25 16:03 Sonalilipsa17375

cc @TRohit20

thulieblack avatar Mar 24 '25 16:03 thulieblack

My only skeptic would be to double check on the click backs and hyperlinks to ensure they work as expected. The rest looks good to me, please ping me after assuring for final review. Thank you

Links are working fine, as reviewed from my side. @TRohit20 If anything's required kindly suggest , I can implement those. Thanks for the review.

Sonalilipsa17375 avatar Mar 29 '25 14:03 Sonalilipsa17375

@Sonalilipsa17375 are you still working on the PR?

thulieblack avatar Apr 23 '25 10:04 thulieblack

Walkthrough

The README.md file was comprehensively rewritten, transforming it from a brief community introduction with sponsor details into a detailed AsyncAPI Community Guide. The updated document now includes a structured Table of Contents, explicit community goals for 2025, step-by-step contribution guidelines, governance information, details about the Technical Steering Committee, an ambassador program overview, and community discussion channels. The previous sponsor logos and meeting announcements were removed, and the new README is organized using headings, bullet points, and markdown diagrams for clarity. No code or exported entity changes were made.

Changes

File(s) Summary of Changes
README.md Rewritten and expanded: added Table of Contents, community goals, contribution guidelines, governance, TSC, ambassador program, community discussion details; removed sponsor logos and meeting info; improved organization and clarity.

Assessment against linked issues

Objective Addressed Explanation
Update README.md to remove outdated sponsors section (#1762)

Possibly related PRs

  • asyncapi/community#1725: Adds a detailed onboarding code contributor guide document, complementing the updated community onboarding and governance information in this PR.

Poem

A README reborn, so crisp and so neat,
With goals for the future and guides to repeat.
The sponsors have hopped, but the bunnies remain,
To welcome new friends down the AsyncAPI lane.
So read, contribute, and join in the cheer—
The community’s thriving, and rabbits are near! 🐇✨

[!NOTE]

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.


[!NOTE]

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings. Enjoy the performance boost—your workflow just got faster.


📜 Recent 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

📥 Commits

Reviewing files that changed from the base of the PR and between 445a116616326a88feca8050f71cfc03d81a98b6 and 3ef267f9e022d1092524d1e4ab0e114cf300f729.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

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

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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

CodeRabbit Commands (Invoked using PR comments)

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

Other keywords and placeholders

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

CodeRabbit Configuration File (.coderabbit.yaml)

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

Documentation and Community

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

coderabbitai[bot] avatar Apr 23 '25 10:04 coderabbitai[bot]

@Sonalilipsa17375 are you still working on the PR?

Yes mam, sorry I missed to reply , on time because of ongoing endsem exams. I will complete the work for sure, the changes you have mentioned. Will update you with the work by this week.

Sonalilipsa17375 avatar Apr 23 '25 10:04 Sonalilipsa17375

Hi @Sonalilipsa17375. I provided some examples of the parts @thulieblack was referring to. :) Let me know if there’s other parts you need help with.

Yeah got it thanks for the reference @CBID2

Sonalilipsa17375 avatar May 12 '25 05:05 Sonalilipsa17375

@Sonalilipsa17375 I updated the readme based on your changes and the review. @CBID2 how does it look now?

thulieblack avatar May 13 '25 10:05 thulieblack

/rtm

thulieblack avatar May 15 '25 06:05 thulieblack