docs: add @ file linking and .claude/rules/ guidance to plugin docs#50
docs: add @ file linking and .claude/rules/ guidance to plugin docs#50JacobPEvans merged 2 commits intomainfrom
Conversation
…pment docs - Add File Linking & Memory Organization section explaining @ import syntax - Document .claude/rules/ for always-active rules with path-specific frontmatter support - Clarify that markdown links are inert; @ syntax is the correct way to link files Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 59dc201 in 6 seconds. Click for details.
- Reviewed
42lines of code in1files - Skipped
0files when reviewing. - Skipped posting
0draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
Workflow ID: wflow_7IbW4WXB9ChIWlkR
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
Summary of ChangesHello @JacobPEvans, 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 enhances the Claude Code plugin development documentation by providing crucial information on how to effectively manage memory and rules. It introduces guidelines for using the Highlights
Changelog
Activity
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
|
There was a problem hiding this comment.
Code Review
This pull request introduces important documentation regarding file linking using the @ syntax and the use of .claude/rules/ for always-active rules. The new sections provide clear explanations and examples, which will be very helpful for plugin authors. However, there appears to be an inconsistency in the documentation regarding the target file. The pull request description states that the changes are for CLAUDE.md, but the actual modifications are in AGENTS.md. Furthermore, the newly added content within AGENTS.md refers to CLAUDE.md. This discrepancy should be clarified to ensure the documentation is accurate and consistent.
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s agent guidance documentation to explain Claude Code’s file-import/linking behavior and how to organize always-active rules so they load into context.
Changes:
- Document
@path/to/fileimports as the supported mechanism for loading referenced content into context (vs inert markdown links). - Add guidance on using
.claude/rules/with optional YAML frontmatter path scoping and symlink support.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Break lines 157, 169, 182 to stay under MD013 line_length limit - Replace "CLAUDE.md" with "plugin documentation" for consistency since these docs live in AGENTS.md Co-Authored-By: Claude <noreply@anthropic.com>
Summary
@path/to/filesyntax as the correct way to link files (markdown links are inert).claude/rules/for always-active rules with path-specific YAML frontmatter supportWhy
Plugin authors writing CLAUDE.md docs for their plugins should know about
@imports and.claude/rules/— both are official Claude Code memory features that make instructions actually load into context rather than just appear as decorative text links.Test plan
🤖 Generated with Claude Code
Important
Adds documentation for file linking and memory organization in Claude Code plugin development, emphasizing
@syntax and.claude/rules/.AGENTS.md.@path/to/filesyntax for file linking, ensuring content is loaded into context..claude/rules/for always-active rules with YAML frontmatter for path-specific scoping..claude/rules/for sharing rules across repos.This description was created by
for 59dc201. You can customize this summary. It will automatically update as commits are pushed.