Skip to content

docs: fix README documentation drift — execution-context, audit, exec-context-pr.js #925

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between README.md and the actual codebase / AGENTS.md:

Findings

Area Issue File(s)
Docs index — authoring docs/execution-context.md listed in AGENTS.md but missing from README.md authoring index README.md
Docs index — internals docs/audit.md listed in AGENTS.md but missing from README.md compiler-internals index README.md
ado-script.md description exec-context-pr.js (third bundle) missing from description; AGENTS.md and docs/ado-script.md both list all three README.md

Details

1. Missing docs/execution-context.md in README authoring index

AGENTS.md documentation index includes docs/execution-context.md under "Authoring agent files" (it's a user-facing feature — the execution-context: front-matter field has its own doc page). README.md's equivalent section was missing this entry. The execution-context: field is listed in the README front-matter table but without a direct link to its reference doc in the documentation index.

2. Missing docs/audit.md in README compiler-internals index

AGENTS.md documentation index includes docs/audit.md under "Compiler internals & operations". README.md references docs/audit.md only in the CLI Reference section but not in the documentation index.

3. exec-context-pr.js missing from docs/ado-script.md blurb in README

docs/ado-script.md opens with: "Today it produces three bundles: gate.js, import.js, exec-context-pr.js". AGENTS.md also lists all three. The README description said only gate.js and import.js.

Applied Fixes

  • Added docs/execution-context.md entry to README "Authoring agent files" docs index (after docs/targets.md, matching AGENTS.md ordering)
  • Added docs/audit.md entry to README "Compiler internals & operations" docs index (after docs/cli.md, matching AGENTS.md ordering)
  • Added exec-context-pr.js to the docs/ado-script.md description in README

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 27197696731 -n agent -D /tmp/agent-27197696731

# Create a new branch
git checkout -b docs/fix-readme-drift-execution-context-ado-script-59d352ba12e5ed58 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27197696731/aw-docs-fix-readme-drift-execution-context-ado-script.patch

# Push the branch and create the pull request
git push origin docs/fix-readme-drift-execution-context-ado-script-59d352ba12e5ed58
gh pr create --title 'docs: fix README documentation drift — execution-context, audit, exec-context-pr.js' --base main --head docs/fix-readme-drift-execution-context-ado-script-59d352ba12e5ed58 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 7.6M ·

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions