docs: add AGENTS.md and llms.txt for agent discoverability - #33
Merged
Conversation
AGENTS.md is contributor-facing (dev setup, lazy-import conventions, release process) so a coding agent working on GAT itself doesn't have to re-derive them from source. llms.txt is end-user-facing, served at the docs site root per the llmstxt.org convention, for agents helping someone consume nlr-gat as a dependency. pyproject.toml gets keywords and richer trove classifiers for PyPI/search discoverability.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.md(repo root): contributor-facing notes for coding agents working on GAT — dev setup, the lazy-import package-boundary convention, testing/fixture env vars, Conventional Commits + release-please process, known gotchas (EGRET removal, H5PLEXOS.jl deprecation,~-path expansion).docs/source/_llms_root/llms.txt(+html_extra_pathinconf.py): end-user-facing, served athttps://natlabrockies.github.io/GridAnalysisToolkit/llms.txtper the llms.txt convention — a curated pointer list for agents helping someone consumenlr-gatas a dependency.pyproject.toml: addedkeywordsand expandedclassifiersfor better PyPI/search discoverability (Python version classifiers,Intended Audience :: Science/Research,Topic :: Scientific/Engineering).Notes
html_extra_path(vs.html_static_path) was verified in an isolated Sphinx smoke test to copy files to the site root rather than nesting under/_static/— needed forllms.txtto land at the conventional path.sphinx.ymlonly builds on push tomain(not on PRs), so the live placement will only be visible after merge + deploy; the isolated smoke test is the pre-merge verification.docs/source/conf.py(single quotes, missing trailing newline) is untouched — out of scope, and not covered by CI's lint job anyway (black --check src/gat testsonly).Test plan
html_extra_pathoutput placementpyproject.tomlparses as valid TOMLhttps://natlabrockies.github.io/GridAnalysisToolkit/llms.txtresolves post-deploy🤖 Generated with Claude Code