Skip to content

docs: import AGENTS.md from a real CLAUDE.md file. - #2293

Merged
XuZhang99 merged 1 commit into
xLLM-AI:mainfrom
shirley-yang-1988:docs/claude-md-reference
Sep 1, 2026
Merged

docs: import AGENTS.md from a real CLAUDE.md file.#2293
XuZhang99 merged 1 commit into
xLLM-AI:mainfrom
shirley-yang-1988:docs/claude-md-reference

Conversation

@shirley-yang-1988

@shirley-yang-1988 shirley-yang-1988 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Description

Replace the root CLAUDE.md symlink with a tracked regular Markdown file whose only content is @AGENTS.md.

Why

Claude Code reads CLAUDE.md and supports @path/to/import, but it does not read AGENTS.md directly. Importing AGENTS.md from a real CLAUDE.md lets Claude Code and other coding agents share one source of truth without duplicating project instructions. Using a regular file instead of a symlink also improves portability across platforms and Git tooling, while leaving room for future Claude-specific guidance.

For the official behavior, see the Claude Code memory documentation.

Change Type

  • Documentation

Validation

  • git diff --check
  • pre-commit run --files CLAUDE.md

This is a documentation-only change; no build or runtime tests are required.

Reviewer Notes

  • AGENTS.md is unchanged.
  • The change is limited to replacing the symlink with a mode 100644 file containing the import directive.

@shirley-yang-1988
shirley-yang-1988 marked this pull request as draft September 1, 2026 04:17
@shirley-yang-1988
shirley-yang-1988 marked this pull request as ready for review September 1, 2026 04:17
@shirley-yang-1988 shirley-yang-1988 changed the title docs: import shared agent instructions into claude file. docs: import AGENTS.md from a real CLAUDE.md file. Sep 1, 2026
@XuZhang99
XuZhang99 merged commit 4e2441d into xLLM-AI:main Sep 1, 2026
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.

2 participants