Production-grade platform engineering handbook — Kubernetes, Terraform, Flux CD, GitHub Actions, AWS, and more.
64
80%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Advisory
Suggest reviewing before use
Use
assets/AGENTS.md.templateas the canonical source. Render it withassets/render.sh— do not regenerate the structure verbatim from this file. This page documents the sections and their intent; the asset file is what gets written to the target repo.
bash assets/render.sh assets/AGENTS.md.template \
REPO_DESCRIPTION="One sentence. What this is. Who depends on it." \
STACK_DESCRIPTION="Runtime, framework, deploy target." \
WORKFLOW_DESCRIPTION="Deploy process, review gates, environments." \
OFF_LIMITS="Paths no agent touches without explicit human instruction." \
COORDINATOR_ROLE="coordinator" \
ROSTER_ROWS="| app | src/, tests/ | release (deploys), reviewer (pre-merge) |" \
CONVENTIONS="Naming, formatting, commit message format." \
DATE="YYYY-MM-DD" \
Q1_ANSWER="<verbatim answer to last-change-shipped question>" \
OFF_LIMITS_ANSWER="<verbatim answer to never-want-agent-to-do question>" \
PAIN_POINTS=" - \"<from interview>\"" \
MODELS=" coordinator: <model-id>"| Section | Purpose |
|---|---|
## How to invoke agents | Always include — developers don't know @mentions exist |
## Repo | One sentence — what this is and who depends on it |
## Stack | Runtime, framework, deploy target — one line each |
## How we work | Deploy process in plain English, review gates, environments |
## Off-limits | Paths no agent touches without explicit human instruction |
## Agent roster | Table: agent → owned paths → handoff targets |
## Conventions | Naming, formatting, commit message format |
| metadata block | Machine-readable — read by upgrade and add modes |
Always use YAML literal block scalars (|) for q1 and off-limits — the developer's answer will contain colons, punctuation, and special characters that corrupt inline YAML strings.
<!-- setup-agents metadata
generated: YYYY-MM-DD
q1: |
<verbatim answer — safe to contain colons, quotes, backticks>
off-limits: |
<verbatim answer>
pain-points:
- "<from interview>"
models:
coordinator: <chosen model-id>
app: <chosen model-id>
-->Read with: sed -n '/<!-- setup-agents metadata/,/-->/p' AGENTS.md
.claude-plugin
.github
assets
commands
docs
examples
agent-self-improve
argocd
awesome-docs
aws
cloudfront
functions
lambda-edge
functions
azure
compliance
conventional-commits
datadog
llm-observability
demo
documentation
dora
dynatrace
fluxcd
github-actions
composite-actions
configure-cloud
db-migrate
docker-build-push
k8s-deploy
notify-slack
pr-comment
release-tag
security-scan
setup-env
setup-terraform
terraform-plan
helm
web-service
templates
karpenter
kubernetes
kyverno
mcp
observability
openshift
pr-review
ownership
runtime-security
setup-agents
terraform
references
scripts
skills
platform-skills
tests