You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`prompts/create-ado-agentic-workflow.md`| AI agents creating workflows | Step-by-step guide for authoring agent `.md` files with correct front matter |
36
37
37
-
All three must stay consistent with the codebase and with each other.
38
+
All of these must stay consistent with the codebase and with each other.
38
39
39
40
## What to Check
40
41
@@ -52,25 +53,25 @@ Look for:
52
53
- New source files not reflected in the architecture tree
53
54
- Moved or renamed files
54
55
55
-
### 2. CLI Commands (`AGENTS.md` + `README.md`)
56
+
### 2. CLI Commands (`docs/cli.md` + `README.md`)
56
57
57
-
Extract the actual CLI commands from `src/main.rs` (look at the `Commands` enum with clap derive) and compare against documented commands in both `AGENTS.md` (CLI Commands section) and `README.md` (CLI Reference section).
58
+
Extract the actual CLI commands from `src/main.rs` (look at the `Commands` enum with clap derive) and compare against documented commands in both `docs/cli.md` and `README.md` (CLI Reference section).
58
59
59
60
Check:
60
61
- All subcommands are documented in both files
61
62
- Arguments and flags match what's in the code
62
63
- Default values in docs match actual defaults in code
63
64
64
-
### 3. Front Matter Fields (`AGENTS.md` + `README.md`)
65
+
### 3. Front Matter Fields (`docs/front-matter.md` + `README.md`)
65
66
66
-
Compare the `FrontMatter` struct in `src/compile/types.rs` against the documented fields in both `AGENTS.md` and `README.md` (Agent File Reference → Front Matter Fields).
67
+
Compare the `FrontMatter` struct in `src/compile/types.rs` against the documented fields in both `docs/front-matter.md` (and the per-concept docs it links to: `docs/engine.md`, `docs/tools.md`, `docs/runtimes.md`, `docs/parameters.md`, etc.) and `README.md` (Agent File Reference → Front Matter Fields).
67
68
68
69
- Are all struct fields documented?
69
70
- Do documented defaults match `#[serde(default)]` values?
0 commit comments