Skip to content

Commit 9a9504a

Browse files
agents: Update contributor notes and CI workflow details
- Clarified the distinction between contributor notes in the root directory (`README.md`, `AGENTS.md`) and site documentation in the `docs/` folder. - Documented the addition of the `Docs` CI workflow for building and deploying the documentation site via GitHub Pages. - Updated workflow descriptions to reflect current CI processes. Assisted-by: Codex
1 parent a6b02c5 commit 9a9504a

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
`tests/test_client.py`).
99
- Workflow definitions are in `.github/workflows/`; adjust only when CI
1010
requirements change.
11-
- Documentation and contributor notes reside at the repo root (`README.md`,
12-
`AGENTS.md`). Automation sessions live in `noxfile.py`; keep shared task logic
13-
there.
11+
- Contributor notes reside at the repo root (`README.md`, `AGENTS.md`), while
12+
the documentation site content lives in `docs/`. Automation sessions live in
13+
`noxfile.py`; keep shared task logic there.
1414

1515
## Build, Test, and Development Commands
1616

@@ -285,8 +285,9 @@
285285

286286
## CI & Publishing Notes
287287

288-
- GitHub Actions run two workflows: `pre-commit` (no AWS credentials) and
289-
`Test and Publish` (Python 3.10–3.14 matrix).
288+
- GitHub Actions run three workflows: `pre-commit` (no AWS credentials),
289+
`Test and Publish` (Python 3.10–3.14 matrix), and `Docs` (GitHub Pages build
290+
and deploy on `main` push/manual dispatch).
290291
- Only the release job assumes the AWS OIDC role to `uv build` and publish with
291292
`uv publish`.
292293
- Keep CodeArtifact credentials out of source control; day-to-day development

0 commit comments

Comments
 (0)