From 54e5698649e5590aee8c4d6bd12c70bf0b69f79b Mon Sep 17 00:00:00 2001 From: ilia Date: Thu, 6 Aug 2026 11:12:19 -0400 Subject: [PATCH] docs: public-safe AGENTS writing-docs link --- AGENTS.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..ec8c434 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,20 @@ +# AGENTS.md — playkit + +Short orientation for Cursor agents. Prefer this over rediscovering the repo. + +## Defaults + +- Read `README.md` for run/install; use `make help` when a Makefile exists. +- Lint and tests are **hard gates** in CI — never add `|| true` to them. +- **Do not** commit secrets; app creds live in Infisical (`secrets.levkin.ca`, `/apps/playkit`). +- Multi-step or ambiguous work → Plan mode first, then Agent mode. + +## Docs voice + +READMEs/guides: [writing-docs.md](https://github.com/Gitilia/project-template/blob/main/docs/writing-docs.md) (no emoji decoration). + +## Close-out + +1. Run the narrowest verify that fits (`make test`, `npm test`, `pytest`, CI workflow locally). +2. Public GitHub mirror (`Gitilia/*`): after README/docs release merges, sync mirrors — see `ansible/docs/guides/github-mirrors.md`. +3. Non-trivial PR: offer review; merge only when the user asks. -- 2.49.1