Skip to content

docs: add used-by section #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 24, 2025
Merged

docs: add used-by section #106

merged 2 commits into from
Mar 24, 2025

Conversation

shenxianpeng
Copy link
Contributor

@shenxianpeng shenxianpeng commented Mar 24, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Introduced a new "Used By" section in the README.md, highlighting organizations that utilize the GitHub Action, including logos and links for better visibility.
    • Enhanced formatting with HTML for improved alignment and accessibility features.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Mar 24, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 24, 2025 •
edited
Loading

Walkthrough

The pull request updates the README.md file by introducing a new section named "Used By". This section contains a collection of logos and links for organizations such as Apache, discovery-unicamp, Texas Instruments, and OpenCADC, along with a pointer to additional users. The content uses HTML for alignment and proper formatting, including specified image widths and alt text for accessibility.

Changes

File Change Summary
README.md Added new "Used By" section featuring HTML-formatted logos and links for organizations (Apache, discovery-unicamp, Texas Instruments, OpenCADC) along with a link to further organizations.

Poem

I'm a hopping rabbit in the code burrow bright,
Skipping in the docs with a gleeful byte,
I've found a "Used By" section that sings with logos in sight,
A parade of names and links shining in the night,
With a joyful thump, I celebrate this update just right!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ee371e and 1cbd7c7.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md
🪧 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 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.

@github-actions GitHub Actions
Copy link
Contributor

Commit-Check ✔️

coderabbitai[bot]
coderabbitai bot reviewed Mar 24, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

57-70: Consider adding inline HTML comments for maintainability.
Adding brief HTML comments (e.g. <!-- Begin Used By Section --> and <!-- End Used By Section -->) around this block could help future maintainers quickly locate and modify this section if needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a14e83e and 9ee371e.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

57-70: Excellent addition of the "Used By" section.
The new section is well-structured and clearly meets the PR objective. The HTML block centers the logos effectively, and each image has appropriate alt text and width attributes for consistent display and accessibility.

@shenxianpeng shenxianpeng enabled auto-merge (squash) March 24, 2025 15:28
@shenxianpeng shenxianpeng disabled auto-merge March 24, 2025 15:28
@shenxianpeng shenxianpeng merged commit 9a4f9d0 into main Mar 24, 2025
3 checks passed
@shenxianpeng shenxianpeng deleted the readme-patch-1 branch March 24, 2025 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@shenxianpeng