Skip to content

DOCS-1722 - Add AGENTS.md as canonical agent context#6872

Draft
kimsauce wants to merge 1 commit into
mainfrom
DOCS-1722-add-agents-md
Draft

DOCS-1722 - Add AGENTS.md as canonical agent context#6872
kimsauce wants to merge 1 commit into
mainfrom
DOCS-1722-add-agents-md

Conversation

@kimsauce

@kimsauce kimsauce commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request adds AGENTS.md as the canonical, cross-tool source of repository context and guardrails for AI coding agents (Claude Code, Cursor, Copilot, Codex), migrating the existing content from CLAUDE.md. CLAUDE.md is trimmed to a one-line pointer to avoid drift between the two files. 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, and static/llms.txt interact, verified against the actual files in this repo.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1722

…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>
@kimsauce kimsauce self-assigned this Jul 7, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Jul 7, 2026
@kimsauce kimsauce marked this pull request as draft July 7, 2026 09:12
@kimsauce kimsauce added the doc:site tech Site/tool maintenance, dependencies, updates label Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file doc:site tech Site/tool maintenance, dependencies, updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant