chore: add claude code doc #606
Conversation
![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 @tac0turtle, 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 introduces a new documentation file, CLAUDE.md, specifically designed to provide comprehensive guidance for AI code assistants like Claude Code. Its purpose is to streamline the interaction of these tools with the repository by detailing its structure, development commands, and architectural elements, ultimately enhancing AI-assisted development and understanding.
Highlights
- AI Assistant Guidance: A new
CLAUDE.mdfile has been added to provide explicit instructions and context for AI code assistants (specificallyclaude.ai/code) on how to interact with this repository and its codebase. - Development Workflow & Architecture Overview: The newly added document outlines common development commands, the high-level architecture of the VitePress-based documentation site for Rollkit, including its content organization and key technical details.
- Contribution Conventions: It also details the recommended development workflow and important conventions for contributing to the documentation, such as using relative links, image placement, and structuring content for various sections like blog posts and guides.
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 or fill out our survey 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. ↩
|
There was a problem hiding this comment.
Code Review
This pull request introduces a CLAUDE.md file to provide context and guidance for AI-assisted development. The file is well-structured and contains useful information about commands, architecture, and conventions. I've provided a few suggestions to improve the clarity and formatting of the content, particularly around the file structure diagram and image path conventions.
| │ ├── da/ # Data availability guides | ||
| │ ├── deploy/ # Deployment guides | ||
| │ ├── evm/ # EVM integration guides | ||
| │ └── execution/ # Execution layer guides |
There was a problem hiding this comment.
For improved readability and maintainability, consider aligning the comments in this file structure overview. This makes the tree easier to parse visually.
| │ ├── da/ # Data availability guides | |
| │ ├── deploy/ # Deployment guides | |
| │ ├── evm/ # EVM integration guides | |
| │ └── execution/ # Execution layer guides | |
| │ ├── da/ # Data availability guides | |
| │ ├── deploy/ # Deployment guides | |
| │ ├── evm/ # EVM integration guides | |
| │ └── execution/ # Execution layer guides |
| │ ├── sequencing/ # Sequencing concepts | ||
| │ └── specs/ # Technical specifications |
There was a problem hiding this comment.
Consider aligning the comments for the subdirectories under learn/ to improve the readability of the file structure diagram.
| │ ├── sequencing/ # Sequencing concepts | |
| │ └── specs/ # Technical specifications | |
| │ ├── sequencing/ # Sequencing concepts | |
| │ └── specs/ # Technical specifications |
| ### Important Conventions | ||
|
|
||
| - Use relative links for internal documentation references | ||
| - Place images in `/public/img/` |
There was a problem hiding this comment.
To avoid ambiguity, clarify the path /public/img/. Based on the project structure, the path relative to the project root is docs/public/img/.
Clarify both the location for placing images and the convention for referencing them.
| - Place images in `/public/img/` | |
| - Place images in `docs/public/img/` and reference them using root-relative paths (e.g., `/img/image.png`) |
Overview