Title: Give clearer guidance on module structure in `AGENTS.md` · Issue #1574 · usethis-python/usethis-python · GitHub
Open Graph Title: Give clearer guidance on module structure in `AGENTS.md` · Issue #1574 · usethis-python/usethis-python
X Title: Give clearer guidance on module structure in `AGENTS.md` · Issue #1574 · usethis-python/usethis-python
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 b...
Open Graph 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...
X 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...
Opengraph URL: https://github.com/usethis-python/usethis-python/issues/1574
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Give clearer guidance on module structure in `AGENTS.md`","articleBody":"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`.\n\nIt would be nice to automate the maintenance of this.\n\nI 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`","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2026-03-27T01:37:45.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/1574/usethis-python/issues/1574"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:7a35a77a-2c64-bfdb-f29d-8a2bdc34cd70 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9CD8:70BDC:AF8A15:F53B9F:6A4C9F1A |
| html-safe-nonce | dd2859c134a46ad05148158554a22151103ea45bca2afed3e7e35fa4c58558b5 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5Q0Q4OjcwQkRDOkFGOEExNTpGNTNCOUY6NkE0QzlGMUEiLCJ2aXNpdG9yX2lkIjoiMTMzMTEyMDM4NjY5NjA2MDY5OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | e4d5e0211b07811c184b47f7e144b253de21a4e8b1eccacc35d574da9731611c |
| hovercard-subject-tag | issue:4148463339 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/usethis-python/usethis-python/1574/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2bc795c7771ab3ea295305ec5432350ff4fc5547ab52c87c2bd879075a4d21fa/usethis-python/usethis-python/issues/1574 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2bc795c7771ab3ea295305ec5432350ff4fc5547ab52c87c2bd879075a4d21fa/usethis-python/usethis-python/issues/1574 |
| og:image:alt | 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... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | nathanjmcdougall |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c |
| turbo-cache-control | no-preview |
| go-import | github.com/usethis-python/usethis-python git https://github.com/usethis-python/usethis-python.git |
| octolytics-dimension-user_id | 216362695 |
| octolytics-dimension-user_login | usethis-python |
| octolytics-dimension-repository_id | 842189705 |
| octolytics-dimension-repository_nwo | usethis-python/usethis-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 842189705 |
| octolytics-dimension-repository_network_root_nwo | usethis-python/usethis-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ae90d426644ca15e89bacceb72e51f4e9dbf85f7 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width