Skip to content

docs: add @ file linking and .claude/rules/ guidance to plugin docs#50

Merged
JacobPEvans merged 2 commits intomainfrom
docs/at-file-linking-rules-docs
Feb 18, 2026
Merged

docs: add @ file linking and .claude/rules/ guidance to plugin docs#50
JacobPEvans merged 2 commits intomainfrom
docs/at-file-linking-rules-docs

Conversation

@JacobPEvans
Copy link
Owner

@JacobPEvans JacobPEvans commented Feb 18, 2026

Summary

  • Adds File Linking & Memory Organization section to the plugin development CLAUDE.md
  • Explains @path/to/file syntax as the correct way to link files (markdown links are inert)
  • Documents .claude/rules/ for always-active rules with path-specific YAML frontmatter support
  • Covers symlink support for sharing rules across repos

Why

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

  • Verify no markdownlint errors on the changed file
  • Confirm the section appears clearly in the Plugin Development guidance

🤖 Generated with Claude Code


Important

Adds documentation for file linking and memory organization in Claude Code plugin development, emphasizing @ syntax and .claude/rules/.

  • Documentation:
    • Adds File Linking & Memory Organization section to AGENTS.md.
    • Explains @path/to/file syntax for file linking, ensuring content is loaded into context.
    • Documents .claude/rules/ for always-active rules with YAML frontmatter for path-specific scoping.
    • Describes symlink support in .claude/rules/ for sharing rules across repos.

This description was created by Ellipsis for 59dc201. You can customize this summary. It will automatically update as commits are pushed.

…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>
Copilot AI review requested due to automatic review settings February 18, 2026 10:36
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to 59dc201 in 6 seconds. Click for details.
  • Reviewed 42 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 draft 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 Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@gemini-code-assist
Copy link

Summary of Changes

Hello @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 @ file linking syntax to ensure content is properly loaded and details the .claude/rules/ directory for persistent, context-aware rule application, thereby empowering plugin authors to create more robust and intelligent agents.

Highlights

  • File Linking Documentation: A new section titled "File Linking & Memory Organization" has been added to the plugin development documentation.
  • @ File Imports: The @path/to/file syntax is now documented as the correct method for linking files to ensure their content is loaded into context, contrasting it with inert Markdown links.
  • .claude/rules/ Guidance: Guidance has been added for using the .claude/rules/ directory for always-active rules, including support for YAML frontmatter to scope rules to specific file patterns.
  • Symlink Support: The documentation now clarifies that symlinks are supported within .claude/rules/ for sharing rules across repositories.
Changelog
  • AGENTS.md
    • Added a new top-level section "File Linking & Memory Organization".
    • Included a subsection explaining the @ file import syntax and its importance over standard Markdown links.
    • Added a subsection detailing the .claude/rules/ directory for always-active rules, including YAML frontmatter for path-specific scoping and symlink support.
Activity
  • No human activity has occurred on this pull request yet.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/file imports 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>
@JacobPEvans JacobPEvans merged commit 94d59a8 into main Feb 18, 2026
5 checks passed
@JacobPEvans JacobPEvans deleted the docs/at-file-linking-rules-docs branch February 18, 2026 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments