Skip to content

docs: keep llms.txt in sync via AGENTS.md; link docs from package docstring #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
micahpw merged 1 commit into from
Aug 4, 2026
+7 −0
Merged

docs: keep llms.txt in sync via AGENTS.md; link docs from package docstring #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ make regen-snapshots
- **No static version string.** GAT uses `setuptools_scm` — version is
derived from git tags at build time (`dynamic = ["version"]` in
`pyproject.toml`). Never hand-edit a version number anywhere.
- **Keep `docs/source/_llms_root/llms.txt` in sync.** It's a hand-written
pointer list for agents helping *end users* of `nlr-gat`, not
auto-generated from the toctree — if you add, remove, or rename a
doc page, or ship a capability significant enough to belong in a
quickstart, update it in the same PR.

## Release process

Expand Down
2 changes: 2 additions & 0 deletions src/gat/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
GAT - Grid Analysis Toolkit

A toolkit for wrangling data for Bulk Grid Dispatch and Transmission Analysis.

Docs: https://natlabrockies.github.io/GridAnalysisToolkit/
"""

__author__ = "Micah Webb"
Expand Down
Loading