Skip to content

Commit a8b00a5

Browse files
docs: split AGENTS.md into per-concept references under docs/ (#348)
Agent-Logs-Url: https://github.com/githubnext/ado-aw/sessions/b9610f36-be8c-45bf-91e4-678d6bfc8aef Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
1 parent a41d5ce commit a8b00a5

19 files changed

Lines changed: 1933 additions & 1803 deletions

.github/workflows/doc-freshness-check.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ The project maintains three documentation files, each serving a different audien
3030

3131
| File | Audience | Purpose |
3232
|------|----------|---------|
33-
| `AGENTS.md` | AI agents (Copilot coding agent) | Full project reference: architecture, types, template markers, safe outputs, CLI commands |
33+
| `AGENTS.md` | AI agents (Copilot coding agent) | High-level project overview, architecture, and index of detailed reference docs under `docs/` |
34+
| `docs/*.md` | AI agents and contributors | Per-concept reference: `docs/front-matter.md`, `docs/schedule-syntax.md`, `docs/engine.md`, `docs/parameters.md`, `docs/tools.md`, `docs/runtimes.md`, `docs/targets.md`, `docs/template-markers.md`, `docs/cli.md`, `docs/safe-outputs.md`, `docs/extending.md`, `docs/mcp.md`, `docs/network.md`, `docs/mcpg.md` |
3435
| `README.md` | Human developers | Quick start, setup guide, CLI reference, configuration examples |
3536
| `prompts/create-ado-agentic-workflow.md` | AI agents creating workflows | Step-by-step guide for authoring agent `.md` files with correct front matter |
3637

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.
3839

3940
## What to Check
4041

@@ -52,25 +53,25 @@ Look for:
5253
- New source files not reflected in the architecture tree
5354
- Moved or renamed files
5455

55-
### 2. CLI Commands (`AGENTS.md` + `README.md`)
56+
### 2. CLI Commands (`docs/cli.md` + `README.md`)
5657

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).
5859

5960
Check:
6061
- All subcommands are documented in both files
6162
- Arguments and flags match what's in the code
6263
- Default values in docs match actual defaults in code
6364

64-
### 3. Front Matter Fields (`AGENTS.md` + `README.md`)
65+
### 3. Front Matter Fields (`docs/front-matter.md` + `README.md`)
6566

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).
6768

6869
- Are all struct fields documented?
6970
- Do documented defaults match `#[serde(default)]` values?
7071
- Are new fields missing from the documentation?
7172
- Are removed fields still documented?
7273

73-
### 4. Template Markers (`AGENTS.md`)
74+
### 4. Template Markers (`docs/template-markers.md`)
7475

7576
Scan template files for markers:
7677

@@ -79,14 +80,14 @@ grep -oP '\{\{[^}]+\}\}' src/data/base.yml
7980
grep -oP '\{\{[^}]+\}\}' src/data/1es-base.yml
8081
```
8182

82-
Compare against documented markers in `AGENTS.md`. Check for:
83+
Compare against documented markers in `docs/template-markers.md`. Check for:
8384
- Undocumented markers
8485
- Documented markers that no longer exist in templates
8586
- Markers whose documented behavior doesn't match the compiler implementation
8687

87-
### 5. Safe Output Tools (`AGENTS.md` + `README.md`)
88+
### 5. Safe Output Tools (`docs/safe-outputs.md` + `README.md`)
8889

89-
Compare tools defined in `src/tools/` against what's documented in both `AGENTS.md` and `README.md` (Safe Outputs section):
90+
Compare tools defined in `src/tools/` against what's documented in both `docs/safe-outputs.md` and `README.md` (Safe Outputs section):
9091
- Are all tools documented with correct parameters?
9192
- Do configuration options match the actual implementation?
9293
- Does `README.md` list all available safe output tools?

.github/workflows/rust-pr-reviewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The compiler processes untrusted markdown input. Check for:
6060

6161
- CLI arguments use `clap` derive macros — no manual argument parsing
6262
- New fields in `FrontMatter` (in `src/compile/types.rs`) have `serde` defaults and are `Option<T>` where appropriate
63-
- New template markers are documented in `AGENTS.md`
63+
- New template markers are documented in `docs/template-markers.md`
6464
- Streaming/efficient parsing preferred — avoid loading entire files into memory unnecessarily
6565
- New public functions that can fail return `anyhow::Result`, not `panic!`
6666

.github/workflows/rust-review-command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The compiler processes untrusted markdown input. Check for:
5858

5959
- CLI arguments use `clap` derive macros — no manual argument parsing
6060
- New fields in `FrontMatter` (in `src/compile/types.rs`) have `serde` defaults and are `Option<T>` where appropriate
61-
- New template markers are documented in `AGENTS.md`
61+
- New template markers are documented in `docs/template-markers.md`
6262
- Streaming/efficient parsing preferred — avoid loading entire files into memory unnecessarily
6363
- New public functions that can fail return `anyhow::Result`, not `panic!`
6464

0 commit comments

Comments
 (0)