Skip to content

docs: add AI agent guidance#3925

Open
pollychen-lab wants to merge 1 commit into
EleutherAI:mainfrom
pollychen-lab:docs/agent-readiness-guides
Open

docs: add AI agent guidance#3925
pollychen-lab wants to merge 1 commit into
EleutherAI:mainfrom
pollychen-lab:docs/agent-readiness-guides

Conversation

@pollychen-lab

Copy link
Copy Markdown

Summary

  • Add root AGENTS.md with concise AI-agent guardrails, repo map, validation checklist, security rules, and links to canonical docs.
  • Add .github/copilot-instructions.md with matching Top Invariants for repository-wide Copilot guidance.
  • Keep detailed install, task, model, CLI, and config procedures linked to existing docs rather than duplicated.

Fixes #3611
Fixes #3612

Testing

  • git diff --check
  • uvx pymarkdownlnt scan AGENTS.md .github/copilot-instructions.md
  • uvx pre-commit run --files AGENTS.md .github/copilot-instructions.md
  • Verified all paths in the repo maps and canonical-doc tables exist
  • Verified the Top Invariants sections match exactly between both files
  • Confirmed line counts: AGENTS.md 81 lines, .github/copilot-instructions.md 76 lines

Docs-only change; full pytest suite was not run.

@CLAassistant

CLAassistant commented Jul 11, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

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.

Add AGENTS.md for AI agent guardrails and repo context Add .github/copilot-instructions.md for repository-wide Copilot guidance

2 participants