Skip to content

docs(skills): make AGENTS.md the single source of truth - #46

Open
Patel230 wants to merge 1 commit into
mainfrom
chore/skills-agents-md-single-source
Open

Patel230 wants to merge 1 commit into
mainfrom
chore/skills-agents-md-single-source

Conversation

@Patel230

Copy link
Copy Markdown
Contributor

Rewrites CLAUDE.md references across the community skill packages so AGENTS.md is the only agent-instructions file the skills point at.

What changed — 104 files

Class Count Action
Plain project-instruction references 228 occurrences / 84 files renamed to AGENTS.md
Lines naming both files 27 edits dropped the CLAUDE.md item
Companion-file / symlink guidance 5 sections removed — obsolete under a single source of truth

The third group actively told authors to create a CLAUDE.md next to AGENTS.md (ln -s AGENTS.md CLAUDE.md, "also generate a CLAUDE.md in the same folder", "exist only as pointers to it"). Those contradict the policy, so they were rewritten rather than renamed.

Deliberately left unchanged

A blind rename produces false documentation, so these were excluded:

  • Claude Code's own artifacts~/.claude/CLAUDE.md, CLAUDE.local.md, .claude/CLAUDE.md, --claude-md. These name real files; renaming them invents paths that do not exist.
  • Skills whose subject is Claude Codecursor-claude-md, ag-claude-code-guide, agc-claude*, prompt-CLAUDE, agent-config-migration, cursor-cross-tool-config. Renaming guts their content.
  • Third-party repo paths and URLs — e.g. claude-code-flow/CLAUDE.md, github.com/kubestellar/console/blob/main/CLAUDE.md. Renaming breaks real links.

Verification

ruff check clean · 382 tests pass · registry regenerated (unchanged).

🤖 Generated with Claude Code

Rewrites CLAUDE.md references across the community skill packages so
AGENTS.md is the only agent-instructions file the skills point at.

- Renamed plain project-instruction references (228 occurrences, 84 files)
- Deduped lists that named both files (27 edits)
- Removed companion-file / symlink guidance that told authors to create a
  CLAUDE.md next to AGENTS.md -- obsolete under a single source of truth

Deliberately left unchanged, because renaming them would make the skills
factually wrong:

- Claude Code's own artifacts: `~/.claude/CLAUDE.md`, `CLAUDE.local.md`,
  `.claude/CLAUDE.md`, `--claude-md`
- Skills whose subject is Claude Code itself (cursor-claude-md,
  ag-claude-code-guide, agc-claude*, prompt-CLAUDE, ...)
- File paths and URLs into third-party repos

ruff clean; 382 tests pass; registry regenerated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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