Skip to content

docs: standardise AI agent context and architecture documentation#1

Open
minketeer wants to merge 1 commit into
mainfrom
ai-readme-seymour
Open

docs: standardise AI agent context and architecture documentation#1
minketeer wants to merge 1 commit into
mainfrom
ai-readme-seymour

Conversation

@minketeer
Copy link
Copy Markdown

Summary

Standardises documentation across the repo for both human and agent consumption.

Changes

  • AGENTS.md created/updated as primary agent context file
  • CLAUDE.md created as lightweight @AGENTS.md pointer with Claude extensions
  • docs/ARCHITECTURE.md created with Mermaid component and sequence diagrams
  • .agents/ directory created with rules/ and commands/ (tool-agnostic)
  • .claude/ retained as compatibility shim pointing to .agents/
  • README.md updated (if materially inaccurate or missing)
  • .gitignore updated with CLAUDE.local.md

Review Notes

Please verify:

  1. Tech stack and commands in AGENTS.md are accurate
  2. Mermaid diagrams in ARCHITECTURE.md reflect actual system topology
  3. Any TODO placeholders that need team input

…/ structure

- AGENTS.md: single source of truth for all AI coding assistants
- CLAUDE.md: lightweight pointer to AGENTS.md with Claude-specific extensions
- docs/ARCHITECTURE.md: Mermaid diagrams and component descriptions
- .agents/: tool-agnostic rules and commands
- README.md: updated to complement agent files

Co-Authored-By: Claude Opus 4.6 <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