docs(website): Add Community Projects section to documentation#828
docs(website): Add Community Projects section to documentation#828
Conversation
…ge versions Add detailed explanation of why XML is chosen as the default output format across all 12 language versions of the documentation. The explanation includes: - Evidence-based decision making from major AI providers - Official recommendations from Anthropic (Claude), Google (Gemini), and OpenAI (GPT) - Direct links to relevant documentation and resources - Consistent messaging across all supported languages This provides users with clear understanding of the technical reasoning behind the XML format choice and supports informed decision-making for their specific use cases. Languages updated: en, ja, zh-cn, ko, es, fr, de, pt-br, hi, id, vi, zh-tw
Created a dedicated page showcasing community-created projects that extend or integrate with Repomix. The page includes editor extensions like the VSCode Repomix Runner, language implementations such as Python Repomix, and integration tools like Rulefy, Codebase MCP, and vibe-tools. This provides visibility for the growing Repomix ecosystem and helps users discover useful community tools. The page is organized by project type with concise descriptions and direct links to repositories.
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 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 WalkthroughAdds a new “Community Projects” guide page in multiple locales and inserts it into the Guide sidebar’s Community group across all locale VitePress configs. Updates “output.md” in several locales to replace a brief XML tip with a fuller “Why XML as default?” section and expanded format examples. No logic changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
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!
This pull request significantly enhances the Repomix documentation by introducing a dedicated 'Community Projects' section, available in all 12 supported languages. This aims to boost ecosystem visibility and help users discover valuable community-contributed tools. Additionally, the documentation clarifies the rationale behind Repomix's default XML output format, providing detailed explanations and references to leading AI providers' recommendations.
Highlights
- New Community Projects Section: A comprehensive 'Community Projects' section has been added to the Repomix documentation website. This section showcases community-created projects that extend, implement, or integrate with Repomix.
- Multilingual Support: The new 'Community Projects' section is available in all 12 supported languages, ensuring broad accessibility for the global Repomix community.
- Project Categorization: Community projects are organized into three distinct categories: Editor Extensions, Language Implementations, and Integration Tools, making it easier for users to discover relevant tools.
- Navigation Updates: The navigation menus across all 12 language versions of the documentation have been updated to include a direct link to the new 'Community Projects' section, positioned prominently within the 'Community' section.
- Enhanced XML Output Explanation: The documentation for the XML output format has been significantly updated to provide a more detailed rationale for its use as the default. This includes explicit references to recommendations from major AI providers like Anthropic (Claude), Google (Gemini), and OpenAI (GPT), highlighting its benefits for AI-assisted code analysis.
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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. ↩
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive Community Projects section to the Repomix documentation website, showcasing community-created projects that extend, implement, or integrate with Repomix. The new section is available across all 12 supported languages with proper localization.
- Added Community Projects pages for all 12 supported languages showcasing 5 community projects
- Updated navigation menus across all language configurations to include the new section
- Enhanced the XML format documentation with detailed explanations of why XML is the default format
Reviewed Changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| Multiple community-projects.md files | New community projects pages created for all 12 supported languages |
| Multiple output.md files | Enhanced XML format documentation with detailed rationale |
| Multiple config files | Navigation updates to include Community Projects links |
| ::: | ||
| ### Why XML as Default Format? | ||
| Repomix uses XML as the default output format based on extensive research and testing. This decision is grounded in both empirical evidence and practical considerations for AI-assisted code analysis. | ||
|
|
There was a problem hiding this comment.
The heading should be followed by a blank line for better markdown formatting consistency.
There was a problem hiding this comment.
Code Review
This is a great addition to the documentation, adding a valuable 'Community Projects' section and improving the explanation for the default XML output format. The internationalization effort across 12 languages is impressive. I've found a few issues, mostly related to consistency and correctness in links and file formatting, which I've detailed in the comments. Once these are addressed, this will be ready to merge.
| { | ||
| text: 'Gemeinschaft', | ||
| items: [ | ||
| { text: 'Community-Projekte', link: '/guide/community-projects' }, |
There was a problem hiding this comment.
The link to 'Community-Projekte' is not localized. It points to /guide/community-projects, which will likely resolve to the English page. To ensure users stay within the German version of the site, the link should be prefixed with the language code, similar to other links in this section.
| { text: 'Community-Projekte', link: '/guide/community-projects' }, | |
| { text: 'Community-Projekte', link: '/de/guide/community-projects' }, |
| { | ||
| text: 'Comunidad', | ||
| items: [ | ||
| { text: 'Proyectos de la Comunidad', link: '/guide/community-projects' }, |
There was a problem hiding this comment.
The link to 'Proyectos de la Comunidad' is not localized. It points to /guide/community-projects, which will likely resolve to the English page. To ensure users stay within the Spanish version of the site, the link should be prefixed with the language code, similar to other links in this section.
| { text: 'Proyectos de la Comunidad', link: '/guide/community-projects' }, | |
| { text: 'Proyectos de la Comunidad', link: '/es/guide/community-projects' }, |
| { | ||
| text: 'Communauté', | ||
| items: [ | ||
| { text: 'Projets de la Communauté', link: '/guide/community-projects' }, |
There was a problem hiding this comment.
The link to 'Projets de la Communauté' is not localized. It points to /guide/community-projects, which will likely resolve to the English page. To ensure users stay within the French version of the site, the link should be prefixed with the language code, similar to other links in this section.
| { text: 'Projets de la Communauté', link: '/guide/community-projects' }, | |
| { text: 'Projets de la Communauté', link: '/fr/guide/community-projects' }, |
| { | ||
| text: 'समुदाय', | ||
| items: [ | ||
| { text: 'समुदाय प्रोजेक्ट्स', link: '/guide/community-projects' }, |
There was a problem hiding this comment.
The link to 'समुदाय प्रोजेक्ट्स' is not localized. It points to /guide/community-projects, which will likely resolve to the English page. To ensure users stay within the Hindi version of the site, the link should be prefixed with the language code, similar to other links in this section.
| { text: 'समुदाय प्रोजेक्ट्स', link: '/guide/community-projects' }, | |
| { text: 'समुदाय प्रोजेक्ट्स', link: '/hi/guide/community-projects' }, |
| { | ||
| text: 'Komunitas', | ||
| items: [ | ||
| { text: 'Proyek Komunitas', link: '/guide/community-projects' }, |
There was a problem hiding this comment.
The link to 'Proyek Komunitas' is not localized. It points to /guide/community-projects, which will likely resolve to the English page. To ensure users stay within the Indonesian version of the site, the link should be prefixed with the language code, similar to other links in this section.
| { text: 'Proyek Komunitas', link: '/guide/community-projects' }, | |
| { text: 'Proyek Komunitas', link: '/id/guide/community-projects' }, |
| ### vibe-tools | ||
| Perplexityによるウェブ検索、GeminiとRepomixによるリポジトリ分析、Stagehandによるブラウザ自動化など、複数の機能を持つAIエージェント用のCLIツールセットです。 | ||
|
|
||
| **リポジトリ**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This prevents issues with some tools and is a common convention. Other new markdown files in this PR, like the English version, include a final newline for consistency.
| **リポジトリ**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| **リポジトリ**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| ### vibe-tools | ||
| Perplexity를 통한 웹 검색, Gemini와 Repomix를 사용한 저장소 분석, Stagehand를 통한 브라우저 자동화를 포함한 여러 기능을 가진 AI 에이전트용 CLI 툴셋입니다. | ||
|
|
||
| **Repository**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This prevents issues with some tools and is a common convention. Other new markdown files in this PR, like the English version, include a final newline for consistency.
| **Repository**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| **Repository**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| ### vibe-tools | ||
| Conjunto de ferramentas CLI para agentes de IA com múltiplas capacidades, incluindo pesquisa na web via Perplexity, análise de repositório com Gemini e Repomix, e automação de navegador com Stagehand. | ||
|
|
||
| **Repositório**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This prevents issues with some tools and is a common convention. Other new markdown files in this PR, like the English version, include a final newline for consistency.
| **Repositório**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| **Repositório**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| ### vibe-tools | ||
| 为 AI 代理提供多种功能的 CLI 工具集，包括通过 Perplexity 进行网络搜索、通过 Gemini 和 Repomix 进行仓库分析，以及通过 Stagehand 进行浏览器自动化。 | ||
|
|
||
| **仓库**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This prevents issues with some tools and is a common convention. Other new markdown files in this PR, like the English version, include a final newline for consistency.
| **仓库**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| **仓库**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| ### vibe-tools | ||
| 為 AI 代理提供多種功能的 CLI 工具集，包括透過 Perplexity 進行網路搜尋、透過 Gemini 和 Repomix 進行儲存庫分析，以及透過 Stagehand 進行瀏覽器自動化。 | ||
|
|
||
| **儲存庫**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This prevents issues with some tools and is a common convention. Other new markdown files in this PR, like the English version, include a final newline for consistency.
| **儲存庫**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
| **儲存庫**: [eastlondoner/vibe-tools](https://github.com/eastlondoner/vibe-tools) | |
Extended the Community Projects feature to all 11 supported languages (Japanese, Chinese Simplified/Traditional, Portuguese, Vietnamese, Hindi, German, Korean, Indonesian, French, Spanish). Each page showcases community-created projects including editor extensions, language implementations, and integration tools. This ensures international users can discover Repomix community projects in their native language, making the ecosystem more accessible globally. All navigation menus have been updated with appropriate translations while maintaining consistent linking structure.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
yamadashy
force-pushed
the
docs/website-format
branch
from
9ffeabe to
430ae52
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #828 +/- ##
=======================================
Coverage 87.36% 87.36%
=======================================
Files 113 113
Lines 6626 6626
Branches 1372 1372
=======================================
Hits 5789 5789
Misses 837 837 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary
Added a comprehensive Community Projects section to the Repomix documentation website, showcasing community-created projects that extend, implement, or integrate with Repomix. This new section is available in all 12 supported languages.
Changes Made
1. Community Projects Pages Created
2. Navigation Updates
3. Content Features
Projects Showcased
Impact
Checklist
npm run testnpm run lint