docs: Add Repomix Explorer Skill documentation#1105
Conversation
…mpatibility Make the skill compatible with various AI coding assistants (Claude Code, Codex, Cline, Gemini CLI, etc.) by removing tool-specific terminology. Changes: - Remove "Available Tools" section (Claude Code specific) - Remove MCP tools reference from Important Notes - Replace "Bash tool/Grep tool/Read tool" with generic terms (shell, pattern search, file reading)
Document the ready-to-use Repomix Explorer skill that enables AI coding assistants to analyze and explore codebases. Include quick install command using add-skill and describe what the skill enables.
Add new documentation page explaining the ready-to-use Repomix Explorer skill for AI coding assistants. Includes quick install command, use cases, and how the skill works.
Add Japanese version of the Repomix Explorer Skill documentation.
Add translations for: de, es, fr, hi, id, it, ko, pt-br, ru, vi, zh-cn, zh-tw
|
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 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. 📝 WalkthroughWalkthroughThis pull request introduces comprehensive documentation for the Repomix Explorer Skill across 14 languages. It generalizes tool-specific references in the skill definition, expands the main README, adds navigation entries to all VitePress locale configurations, and provides localized guide documentation in each supported language. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
Summary of ChangesHello @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 focuses on enhancing the Repomix Explorer Skill by generalizing its internal documentation for broader AI tool compatibility and introducing extensive, multilingual user documentation. The changes aim to improve clarity and accessibility for AI coding assistants utilizing Repomix CLI for codebase analysis, making the skill more versatile and easier to adopt across various platforms. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1105 +/- ##
=======================================
Coverage 87.17% 87.17%
=======================================
Files 116 116
Lines 4382 4382
Branches 1019 1019
=======================================
Hits 3820 3820
Misses 562 562 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
PR Review: docs: Add Repomix Explorer Skill documentationOverviewThis PR adds comprehensive documentation for the Repomix Explorer Skill across 14 languages and generalizes the skill itself to support multiple AI coding assistants beyond Claude Code. Code Quality & Best Practices ✅Strengths:
Documentation Quality:
DetailsDetailed AnalysisSKILL.md Changes: Key improvements:
Website Documentation:
Potential Issues & SuggestionsDetails
Premortem AnalysisPotential Failure Scenarios
Security Considerations ✅
Test Coverage
VerdictApprove - This is a well-structured documentation PR that successfully generalizes the Repomix Explorer skill for multi-tool compatibility and provides comprehensive multilingual documentation. The changes are consistent, follow the projects conventions, and will help users adopt the skill across various AI coding assistants. Minor suggestions above are optional improvements and do not block merging. Reviewed by Claude |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request does a great job of introducing and documenting the new Repomix Explorer Skill. The generalization of the skill to support multiple AI tools is a valuable improvement, and the addition of comprehensive documentation in 14 languages is impressive. The changes are clear and well-executed. I've provided a few suggestions to improve the semantic structure of the new markdown files for better readability and accessibility.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Fix all issues with AI agents
In `@website/client/src/de/guide/repomix-explorer-skill.md`:
- Around line 37-84: Standardize the punctuation and dash usage in the document:
for the workflow numbered list items ("Repomix-Befehle ausführen",
"Ausgabedateien analysieren", "Erkenntnisse liefern") and the bullet lists under
"Skill-Inhalt" and "Verwandte Ressourcen", remove inconsistent trailing
punctuation (no periods at line ends), replace the ASCII hyphen (-) used as a
separator with a consistent typographic dash (use an en dash – with spaces on
both sides or an em dash — without surrounding spaces) throughout, and ensure
header lines that introduce lists keep a colon (e.g., "Der Skill enthält:")
while list entries themselves have no trailing punctuation. Apply these changes
to each occurrence (e.g., the three workflow headings, each bullet in
"Skill-Inhalt", and entries under "Verwandte Ressourcen") for consistent German
typography.
In `@website/client/src/es/guide/repomix-explorer-skill.md`:
- Line 13: Clarify that the example path `.claude/skills/` in
repomix-explorer-skill.md is specific to Claude Code by rewording the sentence
to indicate it's an example for Claude Code (e.g., "ej. (Claude Code):
`.claude/skills/`") or by adding "por ejemplo, en Claude Code" before the path;
update the sentence containing `.claude/skills/` so readers know this path is
not universal to all tools.
In `@website/client/src/fr/guide/repomix-explorer-skill.md`:
- Around line 7-41: Update French typography and casing across the document:
change headings "Installation Rapide" → "Installation rapide", "Ce Qu'il Fait" →
"Ce qu'il fait", and "Comment Ça Marche" → "Comment ça marche"; replace straight
apostrophes (') with typographic apostrophes (’), and insert non‑breaking spaces
before French punctuation that requires them (colon, semicolon, question mark,
exclamation mark) and before list punctuation where applicable; ensure list item
text and dashes (e.g., the three steps under "Comment ça marche") use proper
spacing and punctuation; apply the same fixes to the other referenced block
(lines 73–84) for consistency.
In `@website/client/src/id/guide/repomix-explorer-skill.md`:
- Line 13: Update the sentence that references `.claude/skills/` to make clear
that `.claude/skills/` is only an example path used by Claude Code and not a
universal location for all tools; specifically modify the line containing the
string ".claude/skills/" to add a brief parenthetical or clause stating "example
for Claude Code" or "example path used by Claude Code, not a general tools
location" so readers understand this is contextual and not a global convention.
In `@website/client/src/pt-br/guide/repomix-explorer-skill.md`:
- Around line 5-6: Add a comma for readability in the tool list sentence: locate
the sentence containing "Claude Code, Cursor, Codex, GitHub Copilot e mais." and
insert a comma before "e mais" so it reads "Claude Code, Cursor, Codex, GitHub
Copilot, e mais." to match PT‑BR punctuation conventions.
In `@website/client/src/zh-cn/guide/repomix-explorer-skill.md`:
- Line 13: The sentence stating "此命令将技能安装到您的 AI 助手的技能目录（例如
`.claude/skills/`），使其立即可用。" implies `.claude/skills/` is a default; update the
wording to clarify that `.claude/skills/` is just an example used by Claude Code
(e.g., change to "例如（Claude Code 使用的示例路径 `.claude/skills/`）") so the guide stays
accurate for users of other assistants and the multi-tool messaging remains
correct.
In `@website/client/src/zh-tw/guide/repomix-explorer-skill.md`:
- Line 13: The sentence that says "此命令將技能安裝到您的 AI 助手的技能目錄（例如
`.claude/skills/`），使其立即可用。" is ambiguous; update it to clarify the
`.claude/skills/` path is an example specific to Claude (Claude Code) rather
than a universal tools directory—e.g., change the parenthetical to indicate it's
for Claude Code or add "例如（對於 Claude Code）` .claude/skills/`" so multi-tool
users won't be misled.
🧹 Nitpick comments (5)
.claude/skills/repomix-explorer/SKILL.md (1)
292-294: Consider varying sentence structure in the checklist.Three consecutive checklist items start with "Did you", which slightly reduces readability. Consider rewording one or two for variety.
📝 Optional style improvement
- Did you run the repomix command successfully? - Did you note the metrics from command output? -- Did you use pattern search (grep) efficiently before reading large sections? +- Was pattern search (grep) used efficiently before reading large sections? - Are your insights based on actual data from the output?Based on static analysis feedback.
website/client/.vitepress/config/configFr.ts (1)
41-47: Consider localizing the new sidebar label for consistency.All neighboring items are French, but the new label is English. If this isn’t intentional branding, consider a localized label (e.g., “Skill Repomix Explorer”).
website/client/.vitepress/config/configZhTw.ts (1)
41-47: Consider localizing the new sidebar label for consistency.The surrounding items are zh-TW, while the new label is English. If not intended as a fixed product name, consider a localized label for consistency.
website/client/src/hi/guide/repomix-explorer-skill.md (1)
71-84: Optional: standardize list punctuation in the resources section.The resources list could use more consistent punctuation for readability (some tools flag it). Not blocking, but worth a quick pass.
README.md (1)
1196-1227: Consider adding links to detailed documentation.The Repomix Explorer Skill section provides a good quick overview. However, unlike the language-specific documentation files which include "Related Resources" links, this README section doesn't link to the detailed guide pages. Consider adding a reference to the full documentation for users who want more information.
📝 Suggested addition
Add at the end of the section (after line 1227):
This is useful not only for understanding codebases, but also when you want to implement features by referencing your other repositories. + +For more details and usage examples, see the [Repomix Explorer Skill guide](https://repomix.com/guide/repomix-explorer-skill).
Change **bold:** to #### heading format for better document structure and accessibility in all 14 language documentation files.
Deploying repomix with
|
| Latest commit: |
d09e04c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8554ca28.repomix.pages.dev |
| Branch Preview URL: | https://docs-generalize-repomix-expl.repomix.pages.dev |
PR Review: docs: Add Repomix Explorer Skill documentationSummaryThis PR adds comprehensive documentation for the Repomix Explorer Skill and generalizes the skill itself to support multiple AI coding assistants. The changes include:
Assessment: Approve with Minor SuggestionsCode Quality & Best PracticesStrengths:
The generalization changes are well-executed:
Potential Issues & Considerations1. Path Example Clarity (Recommended) Line 13 in all documentation files mentions 2. English Labels in Non-English Configs (Not Needed) CodeRabbit and Gemini flagged that "Repomix Explorer Skill" remains in English in localized navigation configs. Looking at the existing codebase pattern, many product names like "MCP Server", "GitHub Actions", and "Claude Code" are kept in English across locales. This appears to be intentional branding consistency. 3. README Link to Documentation (Recommended) CodeRabbit's suggestion to add a link to detailed documentation in the README section is valuable. Users who want more examples beyond the quick overview would benefit from: For more details and examples, see the [full documentation](https://repomix.com/guide/repomix-explorer-skill).Security & Performance
Premortem Analysis
VerdictThis is a well-structured documentation PR. The generalization makes the skill more broadly useful, and the multi-language documentation shows excellent attention to internationalization. The changes are straightforward and low-risk. Suggestion for maintainer: Consider CodeRabbit's recommendation to add a documentation link in the README section, but all other feedback from bots can be deferred or ignored based on established project conventions. Review by Claude |
1 participant
Summary
Add documentation for the Repomix Explorer Skill, a ready-to-use agent skill that enables AI coding assistants to analyze and explore codebases using Repomix CLI.
Changes
Skill improvements:
README:
Website documentation (14 languages):
Checklist
npm run testnpm run lint