DOCS-1722 - Add AGENTS.md as canonical agent context - #6872
Open
kimsauce wants to merge 3 commits into
Open
Conversation
…to pointer Migrates CLAUDE.md's content to AGENTS.md so non-Claude AI coding agents (Cursor, Copilot, Codex) pick up the same repo context and guardrails. Claude Code-only items (skills, slash commands, the .claude/commands/jira.md pointer) are grouped under a labeled "Claude Code specifics" section. CLAUDE.md is reduced to a one-line pointer to avoid drift between the two files. Also adds a "Search, crawlers, and LLM-facing files" section documenting how markdown-mirror.js, robots.txt, the external Algolia crawler config, and llms.txt interact — verified against the actual plugin, robots.txt, and llms.txt content in this repo. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
CLAUDE.md must be the literal `@AGENTS.md` import directive for Claude Code to actually auto-load AGENTS.md as memory — a plain markdown link is inert. Also restores content dropped during the CLAUDE.md->AGENTS.md migration: the Key Folders pointer, the pr-template-guide skill cross-reference, and the Atlassian Jira MCP detail in PR rule #5 (the latter two scoped as Claude Code-specific asides). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
kimsauce
marked this pull request as ready for review
July 29, 2026 23:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This pull request adds
AGENTS.mdas the canonical, cross-tool source of repository context and guardrails for AI coding agents (Claude Code, Cursor, Copilot, Codex), migrating the existing content fromCLAUDE.md.CLAUDE.mdis now just the@AGENTS.mdinclude directive, so Claude Code actually auto-loadsAGENTS.mdas memory (a plain markdown pointer doesn't get auto-followed). Claude Code-only items (skills, slash commands,.claude/commands/jira.md) are grouped under a labeled "Claude Code specifics" section so other tools can ignore them.Also documents how
src/plugins/markdown-mirror.js,static/robots.txt, the external Algolia crawler config, andstatic/llms.txtinteract, verified against the actual files in this repo.Migration reasoning (what changed vs. the original CLAUDE.md, and why)
.claude/commands/jira.mddirective moved into "Claude Code specifics" — they're Claude-only features, not cross-tool guardrails.@prefix on Repository/Key Folders URLs (Claude Code-specific mention syntax, meaningless to other tools); generalized "accept edits" to "auto-accept"; generalized the Jira ticket-creation instruction to "three approaches" with a(Claude Code: see .claude/commands/jira.md)aside.pr-template-guideskill cross-reference, and the "Atlassian Jira MCP" detail in PR rule Maintenance: Update to Docusaurus 2.0.0-beta.15 #5 were dropped during the initial migration and have been restored (the latter two as Claude Code-scoped asides, consistent with the pattern above).Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1722