docs: Add and simplify CLAUDE.md files for better AI assistant guidance#672
docs: Add and simplify CLAUDE.md files for better AI assistant guidance#672
Conversation
Streamlined CLAUDE.md to focus on essential project structure and guidelines, removing detailed development guide to improve maintainability and readability. Added separate CLAUDE.md for website directory with specific guidance. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Created comprehensive guidelines for browser extension development including: - Project structure and key features overview - Multi-language internationalization (11 languages) - Manifest V3 compliance and cross-browser support - Development commands and testing procedures - Store deployment considerations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Streamlined website documentation to include only core information: - Project overview with basic architecture - Multi-language support (12 languages) - Translation workflow and new language addition process - Navigation configuration basics Removed detailed technical specifications, development commands, and implementation details to reduce maintenance overhead while preserving essential guidance for internationalization and configuration management. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughThe documentation for the Repomix project was restructured and expanded. The main CLAUDE.md was rewritten to provide a concise project overview, directory structure, and streamlined guidelines. New CLAUDE.md files were added for the browser extension and website subprojects, each detailing their respective structures, development workflows, and localization processes. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant CLAUDE.md
participant browser/CLAUDE.md
participant website/CLAUDE.md
Contributor->>CLAUDE.md: Read project overview, guidelines, and structure
Contributor->>browser/CLAUDE.md: Access extension-specific build and i18n instructions
Contributor->>website/CLAUDE.md: Follow website localization and config procedures
✨ 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. 🪧 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
|
There was a problem hiding this comment.
Pull Request Overview
This pull request restructures and simplifies the CLAUDE.md documentation to provide more targeted guidance for AI assistance across different parts of the Repomix project.
- Simplified the main CLAUDE.md to focus on essential project structure and coding guidelines
- Added browser/CLAUDE.md with guidelines for Manifest V3 and internationalization
- Added website/CLAUDE.md with clear navigation and new language configuration instructions
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/CLAUDE.md | Introduces documentation for website navigation and multi-language support |
| browser/CLAUDE.md | Provides guidelines for browser extension development and internationalization |
| CLAUDE.md | Restructures overall project guidance and coding standards for AI assistants |
Comments suppressed due to low confidence (1)
website/CLAUDE.md:16
- The file name 'configShard.ts' appears ambiguous; please verify if it is intended or should be renamed to 'configShared.ts' for clarity.
3. Shared configurations are in `configShard.ts`
![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 refines the project's AI assistant guidance by decentralizing and streamlining documentation. It simplifies the main CLAUDE.md to cover core project aspects, while introducing new, specialized CLAUDE.md files within the browser/ and website/ directories. This change aims to provide more targeted and maintainable instructions for AI assistants, enhancing their understanding of specific codebase areas and reducing overall documentation maintenance overhead.
Highlights
- Documentation Restructuring: The primary
CLAUDE.mdfile has been significantly simplified, removing extensive development details and focusing on high-level project structure, coding standards, and contribution guidelines. - Specialized AI Guidance: Two new
CLAUDE.mdfiles have been introduced:browser/CLAUDE.mdfor browser extension-specific guidance (Manifest V3, internationalization, cross-browser development) andwebsite/CLAUDE.mdfor website-specific guidelines (VitePress, Hono, multi-language support). - Improved Internationalization Clarity: Dedicated sections in the new
browser/CLAUDE.mdandwebsite/CLAUDE.mdfiles provide clear workflows and guidelines for managing and adding new languages for both the browser extension (11 languages) and the website (12 languages).
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. ↩
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #672 +/- ##
=======================================
Coverage 90.41% 90.41%
=======================================
Files 99 99
Lines 5529 5529
Branches 1180 1180
=======================================
Hits 4999 4999
Misses 530 530 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Deploying repomix with
|
| Latest commit: |
2733141
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ee0a74ce.repomix.pages.dev |
| Branch Preview URL: | https://chore-claude.repomix.pages.dev |
There was a problem hiding this comment.
Code Review
This PR restructures and simplifies the CLAUDE.md files, providing clearer guidance for AI assistants. The changes focus on stable, high-level guidelines, improving maintainability. The review suggests minor clarifications to enhance consistency and accuracy.
![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 (8)
CLAUDE.md (3)
5-9: Project Structure Clarity
The overview and “refer to” pointers are clear. For improved consistency, consider hyperlinking back to the core docs (e.g.,[README.md](README.md),[CONTRIBUTING.md](CONTRIBUTING.md)).
47-56: Bullet Punctuation Consistency
Some guideline items end with a period, others don’t. For a uniform style, either add terminal periods to all bullets or remove them from the ones that have them.
72-75: Add missing period
The line- Description must start with a capital lettershould end with a period to match the other bullets.
browser/CLAUDE.md (3)
1-4: Overview Introduction
The header and intro are concise. Consider adding a link back to the root CLAUDE.md (e.g.,[Core CLAUDE.md](../CLAUDE.md)) to help orient readers.
28-34: Command Documentation
The listed npm scripts cover all workflows. For clarity, align the inline comments (e.g., note thatnpm run lintalso performs type-checking) or consider a tabular format.
42-47: Improve step phrasing and punctuation
- Change “Create directory in …” to “Create a directory in …”.
- Add a terminal period to each numbered step for consistency.
website/CLAUDE.md (2)
12-19: Navigation Steps Punctuation & Filename Check
- Add terminal periods to each numbered item.
- Please verify that the shared config filename is correct: is it
configShard.tsor should it beconfigShared.ts?
21-33: Consistent Numbering Format
Append periods to all steps in the “Adding New Languages” list to maintain a uniform style.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CLAUDE.md(2 hunks)browser/CLAUDE.md(1 hunks)website/CLAUDE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
browser/CLAUDE.md
[uncategorized] ~42-~42: The preposition ‘to’ seems more likely in this position.
Context: ...dding New Languages 1. Create directory in app/_locales/[language_code]/ 2. Add ...
(AI_HYDRA_LEO_REPLACE_IN_TO)
website/CLAUDE.md
[uncategorized] ~8-~8: A comma might be missing here.
Context: ...German (de), French (fr), Spanish (es), Portuguese Brazilian (pt-br), Indonesian (id), Vie...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
CLAUDE.md
[uncategorized] ~75-~75: A period might be missing here.
Context: ...- Description must start with a capital letter ## Pull Request Guidelines - All pull ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[uncategorized] ~110-~110: Possible missing preposition found.
Context: ...ble ## Generate Comprehensive Output - Include all content without abbreviation, unles...
(AI_HYDRA_LEO_MISSING_TO)
⏰ Context from checks skipped due to timeout of 90000ms (16)
- GitHub Check: Build and run (macos-latest, 22.x)
- GitHub Check: Test (windows-latest, 23.x)
- GitHub Check: Test (windows-latest, 20.x)
- GitHub Check: Build and run (windows-latest, 24.x)
- GitHub Check: Build and run (ubuntu-latest, 18.0.0)
- GitHub Check: Build and run (macos-latest, 18.x)
- GitHub Check: Test (ubuntu-latest, 19.x)
- GitHub Check: Build and run (macos-latest, 18.0.0)
- GitHub Check: Build and run (windows-latest, 20.x)
- GitHub Check: Build and run (ubuntu-latest, 18.x)
- GitHub Check: Build and run (windows-latest, 18.x)
- GitHub Check: Build and run (windows-latest, 22.x)
- GitHub Check: Build and run (windows-latest, 23.x)
- GitHub Check: Build and run (windows-latest, 19.x)
- GitHub Check: Build and run (ubuntu-latest, 19.x)
- GitHub Check: Lint TypeScript
🔇 Additional comments (5)
CLAUDE.md (1)
17-23: Directory Tree Completeness
The top-level tree correctly listsbrowser/,src/,tests/, andwebsite/. This matches the project layout.browser/CLAUDE.md (2)
11-24: Directory Structure Accuracy
The tree accurately reflects the extension’s file layout, including_locales/for translations and the builtdist/folder.
38-40: Supported Languages List
All 11 locales are correctly enumerated and formatted.website/CLAUDE.md (2)
1-5: Overview Accuracy
The summary of the VitePress/Hono architecture and multilingual support is clear and complete.
7-9: Language Support Clarity
The list of 12 languages is comprehensive and uses consistent code notation.
Summary
This PR restructures and adds CLAUDE.md files to provide better guidance for AI assistants working on different parts of the Repomix codebase:
Changes
Main CLAUDE.md
Browser Extension Guidelines (browser/CLAUDE.md)
Website Guidelines (website/CLAUDE.md)
Benefits
🤖 Generated with Claude Code