From f080f355847f033ff29571a2931e3a0832683ba5 Mon Sep 17 00:00:00 2001 From: micahpw <6476273+micahpw@users.noreply.github.com> Date: Tue, 4 Aug 2026 11:32:59 -0600 Subject: [PATCH] docs: instruct agents to keep llms.txt in sync; link docs from package 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. --- AGENTS.md | 5 +++++ src/gat/__init__.py | 2 ++ 2 files changed, 7 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index ee5220f..257aa16 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 diff --git a/src/gat/__init__.py b/src/gat/__init__.py index d0a69c2..4e3f0ef 100644 --- a/src/gat/__init__.py +++ b/src/gat/__init__.py @@ -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"