From a3a45427d093a0314cdbf0176eb563acc8f41060 Mon Sep 17 00:00:00 2001 From: Aditya Thebe Date: Wed, 4 Feb 2026 18:37:41 +0545 Subject: [PATCH] docs: add fixture guidelines for AI agents Add guidelines section to AGENTS.md specifying that YAML examples should be imported from submodules using file=directive instead of being written directly in the documentation. --- AGENTS.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index cf5379ef..cbc05c08 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -18,3 +18,14 @@ This repository contains documentation for multiple Flanksource projects built w - Docs for "canary-checker", "mission-control" and shared components under `common`. - Style enforced by Vale, markdownlint, and Prettier via Makefile targets. - Documentation follows Google style, second person, active voice, and present tense. + +## Guidelines + +- Never write yaml examples directly. The examples/fixtures should come from the submodules mission-control | duty | config-db | canary-checker. + use code blocks with file=directive to import the fixtures. Example: + + ```yaml title="canary.yaml" file=/modules/canary-checker/fixtures/minimal/http_simple.yaml + + ``` + + If the required fixtures aren't present then stop and notify the user.