docs: public-safe AGENTS.md writing-docs link

This commit is contained in:
2026-08-05 20:46:56 -04:00
parent 426f482df4
commit 002c6ea488
2 changed files with 24 additions and 0 deletions
+20
View File
@@ -0,0 +1,20 @@
# AGENTS.md — {{REPO_NAME}}
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/{{REPO_NAME}}`).
- 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.
+4
View File
@@ -118,6 +118,10 @@ Public READMEs and guides:
Private homelab docs (ansible, hermes, levkin) may name hosts and IPs.
Still skip emoji and marketing tone.
Repos under `Gitilia/*` are push mirrors from Gitea. After merging a release or
public README/docs change, sync and verify from the ansible repo:
`make github-mirror-sync` then `make github-mirror-health` (see
`ansible/docs/guides/github-mirrors.md`).
## When rewriting existing docs
1. Preserve every real fact (commands, paths, versions, URLs).