Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| Architecture tree |
src/hash.rs exists in codebase but is absent from the architecture listing |
AGENTS.md |
| Architecture tree |
src/safeoutputs/upload_build_artifact.rs exists in codebase but is not listed (only upload_workitem_attachment.rs appears) |
AGENTS.md |
| Safe outputs table |
upload-build-artifact tool is documented in docs/safe-outputs.md (§ "upload-build-artifact") but is absent from the safe outputs tool table |
README.md |
| Safe outputs table |
upload-build-artifact tool is missing from the "All configurable safe output tools" table that agents use when authoring workflows |
prompts/create-ado-agentic-workflow.md |
Details
1. src/hash.rs missing from AGENTS.md
src/hash.rs was added to provide SHA-256 integrity helpers shared by safe-output tools (staging and verifying files between Stage 1 and Stage 3). The AGENTS.md architecture tree lists every other top-level src/*.rs file but omits this one.
2. src/safeoutputs/upload_build_artifact.rs missing from AGENTS.md
The safeoutputs/ listing in AGENTS.md ends with upload_workitem_attachment.rs and does not include upload_build_artifact.rs. The tool is fully implemented and exported from src/safeoutputs/mod.rs.
3. upload-build-artifact missing from README.md safe outputs table
README.md's "Available Safe Output Tools" table (around line 376) lists 17 tools and includes upload-workitem-attachment but omits upload-build-artifact. The tool is fully documented in docs/safe-outputs.md § "upload-build-artifact".
4. upload-build-artifact missing from prompts/create-ado-agentic-workflow.md (high priority)
The "All configurable safe output tools" table in the prompts file (around line 271) is the primary reference AI agents use when authoring new workflow files. It currently lists upload-workitem-attachment but not upload-build-artifact. This means agents creating workflows that need to attach build artifacts will not discover the correct tool.
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check · ● 779.9K · ◷
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
src/hash.rsexists in codebase but is absent from the architecture listingAGENTS.mdsrc/safeoutputs/upload_build_artifact.rsexists in codebase but is not listed (onlyupload_workitem_attachment.rsappears)AGENTS.mdupload-build-artifacttool is documented indocs/safe-outputs.md(§ "upload-build-artifact") but is absent from the safe outputs tool tableREADME.mdupload-build-artifacttool is missing from the "All configurable safe output tools" table that agents use when authoring workflowsprompts/create-ado-agentic-workflow.mdDetails
1.
src/hash.rsmissing fromAGENTS.mdsrc/hash.rswas added to provide SHA-256 integrity helpers shared by safe-output tools (staging and verifying files between Stage 1 and Stage 3). The AGENTS.md architecture tree lists every other top-levelsrc/*.rsfile but omits this one.2.
src/safeoutputs/upload_build_artifact.rsmissing fromAGENTS.mdThe
safeoutputs/listing in AGENTS.md ends withupload_workitem_attachment.rsand does not includeupload_build_artifact.rs. The tool is fully implemented and exported fromsrc/safeoutputs/mod.rs.3.
upload-build-artifactmissing fromREADME.mdsafe outputs tableREADME.md's "Available Safe Output Tools" table (around line 376) lists 17 tools and includesupload-workitem-attachmentbut omitsupload-build-artifact. The tool is fully documented indocs/safe-outputs.md§ "upload-build-artifact".4.
upload-build-artifactmissing fromprompts/create-ado-agentic-workflow.md(high priority)The "All configurable safe output tools" table in the prompts file (around line 271) is the primary reference AI agents use when authoring new workflow files. It currently lists
upload-workitem-attachmentbut notupload-build-artifact. This means agents creating workflows that need to attach build artifacts will not discover the correct tool.Suggested Fixes
src/hash.rsto the architecture tree inAGENTS.md(undersrc/, alongside the other top-level.rsfiles), with a short description such as:src/hash.rs # SHA-256 integrity helpers (file staging between Stage 1 and Stage 3)src/safeoutputs/upload_build_artifact.rsto thesafeoutputs/listing inAGENTS.mdupload-build-artifactrow to the safe outputs table inREADME.md(e.g. afterupload-workitem-attachment):| `upload-build-artifact` | Uploads a workspace file as an attachment to an ADO build |upload-build-artifactrow to the "All configurable safe output tools" table inprompts/create-ado-agentic-workflow.mdwithpermissions.write= ✅, under a "Builds & Branches" or similar categoryThis issue was created by the automated documentation freshness check.