-
Notifications
You must be signed in to change notification settings - Fork 318
[step-names] Align qmd step names: inconsistent verbs and capitalization #23762
Description
Step Name Alignment Issues
Found in: .github/workflows/daily-doc-healer.lock.yml, daily-doc-updater, dev, developer-docs-consolidator, dictation-prompt, glossary-maintainer, smoke-codex, technical-doc-writer, unbloat-docs, weekly-blog-post-writer (10 files)
Summary
Three step names in all qmd-enabled workflows break established naming conventions: inconsistent verb form for cache save/restore operations, and incorrect capitalization of "qmd".
Issues Identified
1. [Medium Priority] Inconsistent pattern: "Cache qmd models" vs "Save qmd index to cache"
Current step name:
"Cache qmd models"(10 files)
Issue:
The project uses a consistent Save <artifact> to cache pattern (e.g., "Save qmd index to cache", "Save cache-memory to cache (default)"), but "Cache qmd models" uses a different verb and drops the to cache suffix.
Suggested improvement:
"Cache qmd models"→"Save qmd models to cache"
2. [Medium Priority] Inconsistent pattern: "Restore qmd models cache" vs "Restore qmd index from cache"
Current step name:
"Restore qmd models cache"(10 files)
Issue:
The companion restore step for qmd models uses a different structure from "Restore qmd index from cache". Both restore from cache, but one says from cache (explicit source) while the other uses cache as a noun (ambiguous).
Suggested improvement:
"Restore qmd models cache"→"Restore qmd models from cache"
3. [High Priority] Capitalization mismatch: "Start QMD MCP Server" vs all other qmd steps
Current step name:
"Start QMD MCP Server"(10 files)
Issue:
Every other qmd-related step uses lowercase qmd (e.g., "Build qmd index", "Cache qmd models", "Setup Node.js for qmd", "Install @tobilu/qmd SDK"), but this step capitalizes it as QMD.
Suggested improvement:
"Start QMD MCP Server"→"Start qmd MCP Server"
Agentic Task Description
To fix these step names:
- Locate the source – Edit the
.mdworkflow files for each affected workflow (not the.lock.yml) - Apply changes – Update the three step names as suggested above
- Recompile – Run
gh aw compile <workflow-name>.mdto regenerate the.lock.yml - Verify – Confirm the compiled
.lock.ymlcontains the updated names
Related Files
- Source workflows:
.github/workflows/*.md(10 affected workflows listed above) - Compiled workflows:
.github/workflows/*.lock.yml - Project glossary:
docs/src/content/docs/reference/glossary.md
Priority
Medium Priority — Affects 10 workflows, breaks established naming patterns but does not affect functionality.
AI generated by Step Name Alignment for daily maintenance
Generated by Step Name Alignment · ◷
- expires on Apr 2, 2026, 7:45 PM UTC