docs: fix documentation drift — directory name, missing codemod, conclusion config#1255
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: fix documentation drift — directory name, missing codemod, conclusion config#1255github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…lusion config - Fix AGENTS.md architecture tree: rename safeoutputs/ → safe_outputs/ (actual directory name on disk) - Add missing 0003_flatten_work_item_config.rs codemod entry to the AGENTS.md codemods section - Fix AGENTS.md docs index: remove misleading reference to a non-existent `conclusion:` front-matter field; Conclusion job config lives under `safe-outputs:` (as docs/conclusion.md itself states) - Fix docs/cli.md Pipeline IR Reference: replace `conclusion:` with `safe-outputs:` — the Conclusion job is emitted when safe-outputs are configured, not when a `conclusion:` key is set Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
safeoutputs/wrong — actual directory issrc/safe_outputs/AGENTS.md0003_flatten_work_item_config.rsexists on disk but not in architecture treeAGENTS.md`conclusion:`front-matter field; config is undersafe-outputs:AGENTS.md`conclusion:`is configured" — no such field existsdocs/cli.mdDetails
1. Wrong directory name (
AGENTS.mdarchitecture tree)The tree listed
src/safeoutputs/but the actual directory on disk issrc/safe_outputs/. This would cause AI agents reading AGENTS.md to look in the wrong place when navigating the codebase.2. Missing codemod in architecture tree (
AGENTS.md)src/compile/codemods/0003_flatten_work_item_config.rsexists and handles the migration of nestedwork-item:config blocks (undernoop,missing-tool,missing-data) to the new flat form withtitle-prefix:/report-as-work-item:. It was absent from the architecture tree.3. Misleading
`conclusion:`field reference (AGENTS.mddocs index)The docs index entry for
docs/conclusion.mdsaid"`conclusion:` configuration for the always-running post-pipeline housekeeping job". There is noconclusion:key inFrontMatter— the Conclusion job is emitted automatically whensafe-outputs:is non-empty, and its configuration lives entirely undersafe-outputs:(asdocs/conclusion.mditself states: "All configuration lives undersafe-outputs:in front matter").4. Same
`conclusion:`confusion indocs/cli.mdThe Pipeline IR Reference section said "plus the optional always-running Conclusion job when
`conclusion:`is configured". Fixed to reference`safe-outputs:`.Applied Fixes
AGENTS.md: renamesafeoutputs/→safe_outputs/in the architecture treeAGENTS.md: add0003_flatten_work_item_config.rsentry to the codemods sectionAGENTS.md: rewritedocs/conclusion.mdindex entry to accurately describe Conclusion job configurationdocs/cli.md: fix "whenconclusion:is configured" → "whensafe-outputs:is configured"This pull request was created by the automated documentation freshness check.