docs: keep llms.txt in sync via AGENTS.md; link docs from package docstring - #36
Merged
Merged
Conversation
…e docstring AGENTS.md now tells contributors to update llms.txt alongside doc changes, since it's hand-written rather than toctree-generated. The top-level gat package docstring gets a docs link too, for an agent that's already imported the package but hasn't read README/PyPI.
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
Two small follow-ups from #33:
AGENTS.md: instructs contributors to updatedocs/source/_llms_root/llms.txtalongside doc changes, since it's hand-written rather than generated from the toctree and will otherwise silently drift.src/gat/__init__.py: adds the docs URL to the top-level package docstring, soimport gat; help(gat)surfaces it for an agent that's already imported the package without having read README/PyPI.Other discoverability paths were already in place, verified rather than assumed:
pyproject.toml's[project.urls]→ surfaced on the PyPI project page's "Project links" sidebarhomepage/topics → already set to the docs URL with relevant keywords🤖 Generated with Claude Code