docs: fix documentation drift — env field description and mcp entrypoint-args wording

[github-actions]

Documentation Freshness Audit

This audit compared the project documentation against the codebase and found two inconsistencies.

Findings

Area	Issue	File(s)
Front matter env field	README describes the field as "reserved, not yet implemented" but it IS accepted by the parser (FrontMatter struct, src/compile/types.rs); it's just not forwarded to the compiled pipeline output	README.md vs docs/front-matter.md
MCP entrypoint-args field	Description "(after the image in docker run)" is confusing — it blurs the distinction between entrypoint-args (args passed to the container entrypoint) and args (Docker runtime flags inserted before the image in docker run)	docs/mcp.md vs code comment in src/compile/types.rs

Details

env field (README.md line 274)

The README said:

Workflow-level environment variables (reserved, not yet implemented)

But docs/front-matter.md correctly says:

# env:   # workflow-level environment variables (accepted by parser, not yet forwarded to compiled pipeline output)

The field has a #[serde(default)] attribute and IS parsed successfully — "not yet implemented" was misleading and could cause an AI agent reading the README to think the field would be rejected by the compiler.

entrypoint-args (docs/mcp.md line 48)

The old description was:

entrypoint-args: Arguments passed to the entrypoint (after the image in `docker run`)

The args: field is described as "inserted before the image in docker run", making the entrypoint-args description ambiguous. The cleaner description matches the code comment in src/compile/types.rs:

Arguments passed to the container entrypoint

Applied Fixes

• README.md: update env field description to match docs/front-matter.md wording — "accepted by parser, not yet forwarded to compiled pipeline output"
• docs/mcp.md: clarify entrypoint-args description to "Arguments passed to the container entrypoint"

---

This pull request was created by the automated documentation freshness check.

---

Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files

• README.md

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually

# Download the patch from the workflow run
gh run download 28089616091 -n agent -D /tmp/agent-28089616091

# Create a new branch
git checkout -b docs/fix-env-field-and-mcp-entrypoint-args-2807de86f8b3ddfe main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-28089616091/aw-docs-fix-env-field-and-mcp-entrypoint-args.patch

# Push the branch and create the pull request
git push origin docs/fix-env-field-and-mcp-entrypoint-args-2807de86f8b3ddfe
gh pr create --title 'docs: fix documentation drift — env field description and mcp entrypoint-args wording' --base main --head docs/fix-env-field-and-mcp-entrypoint-args-2807de86f8b3ddfe --repo githubnext/ado-aw

Generated by Documentation Freshness Check · 2.1K AIC · ⌖ 18.5 AIC · ⊞ 34.6K · ◷