Skip to content

docs: add AGENTS.md - #41

Open
stefan-jansen wants to merge 1 commit into
mainfrom
docs/agents-md
Open

docs: add AGENTS.md#41
stefan-jansen wants to merge 1 commit into
mainfrom
docs/agents-md

Conversation

@stefan-jansen

Copy link
Copy Markdown
Contributor

Summary

  • This is the only one of the six ml4t-* libraries with no root AGENTS.md at all. Adds one mirroring ml4t-engineer/ml4t-diagnostic's structure (directory map, verified entry points, design principles, docs links), including a pointer to the existing docs/book-guide/index.md chapter-to-API mapping.
  • Entry-point symbols were cross-checked against src/ml4t/models/init.py, not invented.

Test plan

  • Docs-only change; pre-commit hooks (ruff, ty, pytest) pass.

Every other ml4t-* library ships a root AGENTS.md for agent orientation;
this one had none. Mirrors ml4t-engineer/ml4t-diagnostic's structure and
points at the existing docs/book-guide/index.md chapter-to-API mapping.
Copilot AI lite review requested due to automatic review settings August 14, 2026 21:19

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@stefan-jansen stefan-jansen added compatibility: none No known compatibility impact ecosystem Tracked by a shared ML4T ecosystem requirement priority: normal Normal planned work status: pending-review Acknowledged and waiting for the stated review point type: documentation Documentation content or process labels Aug 26, 2026
@stefan-jansen

Copy link
Copy Markdown
Contributor Author

Pending ecosystem review. The maintainer requested a seven-library audit of agent-facing navigation and instruction files before any one-library approach is adopted. This PR will be reviewed against that standard after the current stable-release qualification completes; do not merge it independently.

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

Labels

compatibility: none No known compatibility impact ecosystem Tracked by a shared ML4T ecosystem requirement priority: normal Normal planned work status: pending-review Acknowledged and waiting for the stated review point type: documentation Documentation content or process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants