feat(docs): Add sponsors badge and improve documentation transparency#639
feat(docs): Add sponsors badge and improve documentation transparency#639
Conversation
Add GitHub sponsors badge to homepage across all 12 language versions for consistent sponsor visibility and recognition. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…e version Add missing link to JSNation Open Source Awards 2025 in Japanese index page to match all other language versions. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Add GitHub sponsors badge prominently after project description for better sponsor visibility and recognition. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Add explanation about temporary server storage of uploaded files and automatic deletion after processing for transparency. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughSponsor badges linking to the GitHub Sponsors page for "yamadashy" were added to the main README and all localized website index files. The README's privacy policy section was expanded to clarify the handling of uploaded ZIP files. The Japanese index also updated the awards nomination section with a hyperlink. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Website (Localized Index)
participant GitHub Sponsors
User->>Website (Localized Index): Loads homepage
Website (Localized Index)->>User: Renders sponsor badge with link
User->>GitHub Sponsors: Clicks sponsor badge
GitHub Sponsors-->>User: Displays sponsorship page
Possibly related PRs
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
Documentation and Community
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @yamadashy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello! Gemini or gemini-code-assist here, providing a summary of this pull request by @yamadashy. This PR focuses on enhancing the project's documentation and transparency. The main changes involve adding sponsor badges to prominent locations, fixing a specific link in the Japanese documentation, and providing more clarity in the privacy policy regarding file handling on the website.
Highlights
- Sponsor Visibility: Adds a sponsor badge to the main README.md file and the index pages for all 12 language versions of the project website to increase visibility for sponsors.
- Documentation Accuracy: Corrects a missing link to the JSNation Open Source Awards in the Japanese version of the website's index page.
- Privacy Policy Clarity: Updates the privacy policy section in README.md to explicitly state that uploaded files for processing are temporarily stored and automatically deleted immediately after processing.
Changelog
Click here to see the changelog
- README.md
- Added sponsors badge image and link after the project description.
- Added a line to the privacy policy clarifying temporary file storage and automatic deletion for file processing.
- website/client/src/de/index.md
- Added sponsors badge image and link.
- website/client/src/en/index.md
- Added sponsors badge image and link.
- website/client/src/es/index.md
- Added sponsors badge image and link.
- website/client/src/fr/index.md
- Added sponsors badge image and link.
- website/client/src/hi/index.md
- Added sponsors badge image and link.
- website/client/src/id/index.md
- Added sponsors badge image and link.
- website/client/src/ja/index.md
- Added sponsors badge image and link.
- Added the missing link to the JSNation Open Source Awards.
- website/client/src/ko/index.md
- Added sponsors badge image and link.
- website/client/src/pt-br/index.md
- Added sponsors badge image and link.
- website/client/src/vi/index.md
- Added sponsors badge image and link.
- website/client/src/zh-cn/index.md
- Added sponsors badge image and link.
- website/client/src/zh-tw/index.md
- Added sponsors badge image and link.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Deploying repomix with
|
| Latest commit: |
dcaaacf
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6c06924a.repomix.pages.dev |
| Branch Preview URL: | https://chore-docs.repomix.pages.dev |
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation transparency by adding a sponsors badge to multiple language index pages and the README while clarifying the file processing policy.
- Inserts a sponsors badge link consistently across 12 website language pages.
- Fixes an issue with the JSNation Open Source Awards link in the Japanese version.
- Updates the privacy policy text in the README to specify details on temporary file processing.
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| website/client/src/zh-tw/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/zh-cn/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/vi/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/pt-br/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/ko/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/ja/index.md | Added sponsors badge and updated the awards link formatting |
| website/client/src/id/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/hi/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/fr/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/es/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/en/index.md | Added sponsors badge before the awards nomination section |
| website/client/src/de/index.md | Added sponsors badge before the awards nomination section |
| README.md | Added sponsors badge and clarified file processing details |
Comments suppressed due to low confidence (1)
README.md:1257
- Ensure that the updated file processing information is fully aligned with internal privacy policies, and consider adding details on retention duration if applicable.
- **File Processing**: When uploading ZIP files or folders, your files are temporarily stored on our servers for processing. All uploaded files and processed data are automatically deleted immediately after processing is complete.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #639 +/- ##
=======================================
Coverage 90.32% 90.32%
=======================================
Files 96 96
Lines 4962 4962
Branches 1042 1042
=======================================
Hits 4482 4482
Misses 480 480 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request effectively adds sponsor visibility and improves documentation transparency. The changes are consistent and the link fix is appreciated. I have two main suggestions related to accessibility of the new sponsor badges on localized website pages and clarification on the privacy policy's reach.
Summary of Findings
- Accessibility of Sponsor Badge Alt Text: The
alttext for the newly added sponsor badges on the 11 non-English website index pages is currently in English ("Sponsors"). For better accessibility, this text should be translated into the respective language of each page. This was raised as a review comment. - Privacy Policy Update Scope: The privacy policy clarification regarding temporary file processing has been added to the
README.md. It's important to confirm if a separate privacy policy page on therepomix.comwebsite also requires this update for consistency. This was raised as a review comment. - README Sponsor Badge Accessibility: The sponsor badge added to the README is missing
alttext, which impacts accessibility. Addingalt="Sponsors"would improve this.
Merge Readiness
The pull request introduces valuable improvements. However, before merging, I recommend addressing the medium severity issues raised: ensuring the accessibility of the sponsor badge alt text on localized pages and clarifying the scope of the privacy policy update with respect to any dedicated privacy page on repomix.com. Also, adding alt text to the README sponsor badge would be beneficial. Once these points are clarified or addressed, the PR should be in good shape. As an AI, I am not authorized to approve pull requests; please ensure further review and approval by team members.
website/client/src/de/index.md
Outdated
|
|
||
| <div class="cli-section"> | ||
|
|
||
| [](https://github.com/sponsors/yamadashy) |
There was a problem hiding this comment.
The alt text for the new sponsors badge is currently "Sponsors" (English). For improved accessibility on localized pages like this German version, web accessibility guidelines recommend translating alt text. 1
Given that this PR modifies all language versions for the badge addition, is there a plan to translate this alt text for each respective language (e.g., "Sponsoren" for German)? Or is the expectation that the maintainer translation process (mentioned in CONTRIBUTING.md) will cover this attribute later?
Using the English alt text on non-English pages is not ideal for accessibility. This consideration applies to the sponsor badges added in all 11 non-English index.md files (de, es, fr, hi, id, ja, ko, pt-br, vi, zh-cn, zh-tw). The English version (en/index.md) can, of course, retain alt="Sponsors".
Style Guide References
Footnotes
-
W3C WAI (Web Accessibility Initiative) guidelines state: "If an image is part of a page that is translated into several languages, the alternative text should also be translated into these languages." (Source: https://www.w3.org/WAI/tutorials/images/localization/) ↩
![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 (9)
website/client/src/zh-cn/index.md (1)
29-29: Sponsor badge insertion: The sponsors badge is correctly added within thecli-sectionas per PR objectives. Consider localizing the alt text "Sponsors" to Chinese (e.g., “赞助者”) for improved accessibility.website/client/src/de/index.md (1)
29-29: Sponsor badge addition: The sponsorship badge is correctly positioned above the awards section. Optionally, translate the alt text "Sponsors" to German (e.g., “Sponsoren”) for better localization.website/client/src/id/index.md (1)
29-29: Sponsor badge insertion: Correctly added before the awards section. Consider translating the alt text "Sponsors" to Indonesian (e.g., “Sponsor”) to match the document language.website/client/src/pt-br/index.md (1)
29-29: Sponsor badge added: Badge is correctly placed insidecli-section. Consider translating the alt text "Sponsors" into Portuguese (e.g., “Patrocinadores”) for localization.website/client/src/hi/index.md (1)
29-29: Sponsor badge addition: The badge is appropriately inserted before the awards section. Consider localizing the alt text "Sponsors" to Hindi (e.g., “प्रायोजक”) to enhance accessibility.website/client/src/fr/index.md (1)
26-26: Check sponsor badge accessibility.
The inserted badge aligns with other locales, but consider making thealttext more descriptive (for example,alt="Sponsors of Repomix") to improve screen‐reader support.website/client/src/ja/index.md (1)
29-29: Ensure badge accessibility and consistency.
The sponsor badge placement is correct. For better accessibility, update thealtattribute to something likealt="Sponsors of Repomix".README.md (2)
52-52: Consolidate sponsor badges.
There’s already a GitHub Sponsors badge at line 42. To avoid redundancy, consider replacing that static badge with the dynamic jsdelivr version—or vice versa—and keep one.
1257-1257: Align privacy policy bullet style.
The new file-processing bullet is clear, but ensure its indentation, punctuation, and formatting (e.g., trailing period) match the neighboring bullets for consistency.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
README.md(2 hunks)website/client/src/de/index.md(1 hunks)website/client/src/en/index.md(1 hunks)website/client/src/es/index.md(1 hunks)website/client/src/fr/index.md(1 hunks)website/client/src/hi/index.md(1 hunks)website/client/src/id/index.md(1 hunks)website/client/src/ja/index.md(1 hunks)website/client/src/ko/index.md(1 hunks)website/client/src/pt-br/index.md(1 hunks)website/client/src/vi/index.md(1 hunks)website/client/src/zh-cn/index.md(1 hunks)website/client/src/zh-tw/index.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
- GitHub Check: Build and run (macos-latest, 19.x)
- GitHub Check: Build and run (macos-latest, 23.x)
- GitHub Check: Build and run (windows-latest, 21.x)
- GitHub Check: Build and run (macos-latest, 18.x)
- GitHub Check: Build and run (macos-latest, 20.x)
- GitHub Check: Build and run (windows-latest, 24.x)
- GitHub Check: Build and run (windows-latest, 22.x)
- GitHub Check: Build and run (windows-latest, 20.x)
- GitHub Check: Build and run (windows-latest, 19.x)
- GitHub Check: Build and run (windows-latest, 18.x)
- GitHub Check: Build and run (ubuntu-latest, 21.x)
- GitHub Check: Build and run (ubuntu-latest, 18.x)
- GitHub Check: Test (windows-latest, 19.x)
- GitHub Check: Test (windows-latest, 23.x)
- GitHub Check: Test (windows-latest, 21.x)
- GitHub Check: Test (windows-latest, 20.x)
- GitHub Check: Test (windows-latest, 18.x)
- GitHub Check: Test (windows-latest, 18.0.0)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (6)
website/client/src/zh-tw/index.md (1)
29-29: Sponsor badge insertion looks goodThe badge is correctly placed within the
cli-sectionand matches the format used across other locales.website/client/src/vi/index.md (1)
29-29: Sponsor badge insertion looks goodThe badge is correctly placed within the
cli-sectionand matches the format used across other locales.website/client/src/ko/index.md (1)
29-29: Sponsor badge insertion looks goodThe badge is correctly placed within the
cli-sectionand matches the format used across other locales.website/client/src/en/index.md (1)
29-29: Sponsor badge insertion looks goodThe badge is correctly placed within the
cli-sectionand matches the format used across other locales.website/client/src/es/index.md (1)
29-29: Sponsor badge insertion looks goodThe badge is correctly placed within the
cli-sectionand matches the format used across other locales.website/client/src/ja/index.md (1)
33-33: Verify updated awards hyperlink.
The nomination text now includes the awards link inline. Please confirm the Japanese phrasing reads naturally and that the link styling matches the rest of the site (e.g., target behavior).
Update sponsors badge URLs from .svg to .png format across all documentation files for consistent display and proper functionality. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Add sponsors badge to guide index pages across all 12 languages for consistent sponsor visibility throughout documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Summary
Test plan
🤖 Generated with Claude Code