Description
The Quick Start docs mention the .lock.yml compiled file but do not clearly tell users that committing it is intentional and required. New users may be confused about whether to commit a generated file.
From the Documentation Noob Tester Report — 2026-07-18:
"Step 4 mentions 'the compiled workflow that GitHub Actions actually runs' and 'you never edit it by hand.' But there's no visual of what this file looks like or why it exists. A beginner will wonder if they accidentally committed a generated file and whether that's right."
Suggested Changes
- In
docs/src/content/docs/setup/quick-start.md, after the gh aw compile step, add a callout box:
"Yes, commit both the .md source and the .lock.yml — the lock file is intentional and required by GitHub Actions to run your workflow."
- Optionally add a brief mention in the docs FAQ or glossary.
Files Affected
docs/src/content/docs/setup/quick-start.md — compile step section
Success Criteria
- A user who sees a generated
.lock.yml file knows immediately that committing it is correct.
- Documentation build passes.
- No existing content is removed.
Source
Extracted from Documentation Noob Test Report — 2026-07-18 #46338
Priority
Low — quick documentation win; reduces new-user friction at first compile.
🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · 308.6 AIC · ⌖ 5.31 AIC · ⊞ 7K · ◷
Description
The Quick Start docs mention the
.lock.ymlcompiled file but do not clearly tell users that committing it is intentional and required. New users may be confused about whether to commit a generated file.From the Documentation Noob Tester Report — 2026-07-18:
Suggested Changes
docs/src/content/docs/setup/quick-start.md, after thegh aw compilestep, add a callout box:Files Affected
docs/src/content/docs/setup/quick-start.md— compile step sectionSuccess Criteria
.lock.ymlfile knows immediately that committing it is correct.Source
Extracted from Documentation Noob Test Report — 2026-07-18 #46338
Priority
Low — quick documentation win; reduces new-user friction at first compile.