Skip to content

[docs] Consolidate agent instructions: move universal content to AGENTS.md, pointer in CLAUDE.md#274

Open
jjshanks wants to merge 1 commit into
NateBJones-Projects:mainfrom
jjshanks:docs/consolidate-agent-instructions
Open

[docs] Consolidate agent instructions: move universal content to AGENTS.md, pointer in CLAUDE.md#274
jjshanks wants to merge 1 commit into
NateBJones-Projects:mainfrom
jjshanks:docs/consolidate-agent-instructions

Conversation

@jjshanks
Copy link
Copy Markdown

@jjshanks jjshanks commented May 8, 2026

Contribution Type

  • Recipe (/recipes)
  • Schema (/schemas)
  • Dashboard (/dashboards)
  • Integration (/integrations)
  • Skill (/skills)
  • Repo improvement (docs, CI, templates)

What does this do?

Consolidates all agent instructions into AGENTS.md as the single source of truth. CLAUDE.md is now a thin pointer that references AGENTS.md, with only the Claude Desktop-specific MCP connector path preserved. Removes duplicated content (repo structure, guard rails, PR standards, key files, GSD layer) between the two files.

Requirements

None — this is a docs-only change.

Checklist

  • I've read CONTRIBUTING.md
  • No credentials, API keys, or secrets are included

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 8, 2026
@alanshurafa alanshurafa added area: docs Review area: documentation review: ready-for-maintainer Community reviewer recommends maintainer review alan-reviewed Reviewed by Alan Shurafa in Community Reviewer role labels May 20, 2026
@alanshurafa
Copy link
Copy Markdown
Collaborator

Thanks for the contribution. Consolidating the universal repo-orientation content into AGENTS.md and leaving CLAUDE.md as a pointer is a sensible refactor — AGENTS.md is the tool-agnostic location, and it de-duplicates guidance that applies to every AI tool, not just Claude.

The change is a roughly balanced move (+60/-56). One thing for the maintainer to confirm, since this is the contributor-contract documentation: that the move is complete (no guidance dropped between the two files) and that the CLAUDE.md pointer is enough for Claude-specific tooling that may read CLAUDE.md first. Recommend maintainer review.

— Alan (community reviewer; non-binding)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

alan-reviewed Reviewed by Alan Shurafa in Community Reviewer role area: docs Review area: documentation documentation Improvements or additions to documentation review: ready-for-maintainer Community reviewer recommends maintainer review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants