Skip to content

Add AGENTS.md with repo structure and build guidance#857

Open
drbenvincent wants to merge 1 commit intomainfrom
add-agents-md
Open

Add AGENTS.md with repo structure and build guidance#857
drbenvincent wants to merge 1 commit intomainfrom
add-agents-md

Conversation

@drbenvincent
Copy link
Contributor

Summary

  • Adds an AGENTS.md file documenting repo conventions for AI coding agents
  • Covers notebook file pairing (.ipynb source of truth, .myst.md auto-generated)
  • Documents that RTD builds don't execute notebooks, so missing Python packages can't cause RTD failures
  • Notes that RTD "Unknown problem" failures with short duration are transient and should be retriggered
  • Reminds agents not to commit scratch artifacts

Test plan

  • Pre-commit hooks pass
  • Verify file renders correctly on GitHub

Made with Cursor

@drbenvincent drbenvincent requested a review from OriolAbril March 5, 2026 15:14
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