Skip to content

docs: fix documentation drift — IR module tree and template-markers link #997

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree src/compile/ir/ directory (11 files) and four per-target IR builders (standalone_ir.rs, onees_ir.rs, job_ir.rs, stage_ir.rs) missing from compile module tree AGENTS.md
Broken link docs/template-markers.md referenced but file does not exist (template system was replaced by typed IR) README.md
Stale description docs/extending.md described as covering "template markers" — file actually covers typed IR extensions README.md

Details

Finding 1 — AGENTS.md architecture tree missing IR layer

The compile module tree in AGENTS.md showed only the legacy *.rs entry points (standalone.rs, onees.rs, job.rs, stage.rs). The actual source tree contains:

  • src/compile/ir/ — a full subdirectory with 11 typed-IR files (mod.rs, ids.rs, step.rs, job.rs, stage.rs, env.rs, condition.rs, output.rs, graph.rs, lower.rs, emit.rs)
  • src/compile/standalone_ir.rs, onees_ir.rs, job_ir.rs, stage_ir.rs — per-target typed-IR builder modules that replaced src/data/*-base.yml

These are already documented in docs/ir.md but were absent from the AGENTS.md architecture tree, which AI coding agents use to navigate the codebase.

Finding 2 — README.md broken link to docs/template-markers.md

README.md referenced docs/template-markers.md but that file does not exist. The template marker system it would have described was replaced by the typed IR (src/compile/ir/). The link was removed and replaced with a correct reference to docs/ir.md.

Finding 3 — README.md stale description for docs/extending.md

The README description for docs/extending.md said it covered "template markers" — obsolete terminology from the removed template system. The actual file covers typed IR extensions. Updated to match.

Applied Fixes

  • AGENTS.md: Added src/compile/ir/ directory tree (11 files with descriptions) to the compile module architecture section
  • AGENTS.md: Added standalone_ir.rs, onees_ir.rs, job_ir.rs, stage_ir.rs entries with descriptions
  • README.md: Removed broken docs/template-markers.md link; added docs/ir.md link in Compiler internals section
  • README.md: Fixed docs/extending.md description from "template markers" to "typed IR extensions"

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
  • AGENTS.md
  • 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 27473116946 -n agent -D /tmp/agent-27473116946

# Create a new branch
git checkout -b docs/fix-documentation-drift-ir-and-template-markers-0ba62c32f5012344 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27473116946/aw-docs-fix-documentation-drift-ir-and-template-markers.patch

# Push the branch and create the pull request
git push origin docs/fix-documentation-drift-ir-and-template-markers-0ba62c32f5012344
gh pr create --title 'docs: fix documentation drift — IR module tree and template-markers link' --base main --head docs/fix-documentation-drift-ir-and-template-markers-0ba62c32f5012344 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 9.8M ·

Metadata

Metadata

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