docs: fix documentation drift — env field status and export-gate-schema command#805
Merged
Merged
Conversation
…ma command Fixes identified in documentation freshness audit: 1. **docs/front-matter.md** — Removed incorrect RESERVED comment from env: field. The field is implemented (src/compile/types.rs:125-127) and has been available since early versions. Documentation incorrectly told users the feature was unavailable. 2. **docs/cli.md** — Documented export-gate-schema hidden build-time tool in a new 'Hidden Build-Time Tools' section. This command exists in src/main.rs:424-431 but was previously only mentioned in passing without proper introduction. All other documentation checked and found accurate: - CLI commands match src/main.rs Commands enum - Template markers in docs/template-markers.md match all four template files - Safe output tools are fully documented (24 tools in src/safeoutputs/) - FrontMatter struct fields are documented across docs/front-matter.md and linked per-concept docs - AGENTS.md architecture tree matches actual directory structure 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 compared project documentation against the actual codebase to identify drift between docs and implementation. The audit checked:
src/main.rsvsdocs/cli.md)src/compile/types.rsvsdocs/front-matter.md)src/data/*.ymlvsdocs/template-markers.md)src/safeoutputs/vsdocs/safe-outputs.md)AGENTS.mdvs actual directory structure)Findings
env:marked as "RESERVED: not yet implemented" but is actually implementeddocs/front-matter.md:60-61export-gate-schemahidden build-time tool was undocumenteddocs/cli.mdDetails
1.
env:Field Status (CRITICAL)docs/front-matter.md:60-61incorrectly marked theenv:field as "RESERVED" with a comment stating it was "not yet implemented":However,
src/compile/types.rs:125-127shows the field is fully implemented:Impact: Users were told a working feature was unavailable, preventing them from using workflow-level environment variables.
Fix: Removed the "RESERVED" comment and uncommented the example, showing the field as available.
2.
export-gate-schemaCommand (DOCUMENTATION GAP)The
export-gate-schemacommand exists insrc/main.rs:424-431:It was referenced in
docs/cli.md:120-122but never introduced or explained in the main command list.Impact: Contributors working on the
scripts/ado-scriptTypeScript workspace had no documentation for this build-time tool.Fix: Added a new "Hidden Build-Time Tools" section in
docs/cli.mddocumentingexport-gate-schemawith usage and context.Applied Fixes
env:field indocs/front-matter.mdand removed incorrect "RESERVED" statusexport-gate-schemain new "Hidden Build-Time Tools" section indocs/cli.mdVerified Accurate (No Changes Needed)
src/main.rsCommands enum are documentedbase.yml,1es-base.yml,job-base.yml,stage-base.ymlare documented indocs/template-markers.mdsrc/safeoutputs/are documented indocs/safe-outputs.mdsrc/compile/types.rsare documented acrossdocs/front-matter.mdand linked concept docsAGENTS.md:44-150accurately reflects actual directory structuredocs/schedule-syntax.mdmatchessrc/fuzzy_schedule.rsThis pull request was created by the automated documentation freshness check workflow.