-
Notifications
You must be signed in to change notification settings - Fork 3
Give clearer guidance on module structure in AGENTS.md #1574
Description
In #1565 the agent did not add an option to the centralized options module. Rather than create a bespoke skill for a somewhat esoteric point, I think we should include a documentation of the module tree structure in AGENTS.md.
It would be nice to automate the maintenance of this.
I think the key idea would be that we want to automate the generation of the tree diagram in a way that reads through module docstrings to annotate a ASCII tree diagram and keeps them in-sync via a prek hook. That would live in a doc/* file and we would have a separate prek hook to ensure that it's verbatim included somewhere in AGENTS.md. And we'd include some skills guidance about how to modify module structure to mention that we need to re-run the tree maintenance hook and then get the LLM to keep it in sync with AGENTS.md