-
Notifications
You must be signed in to change notification settings - Fork 32
Open
Labels
automationbugSomething isn't workingSomething isn't workingclidocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Issue Description
Command: gh aw compile
Type: Inconsistent terminology/capitalization
Priority: Medium
Location: cmd/gh-aw/main.go line 169
Current Output
Short: "Compile Markdown to YAML workflows"Issue
The compile command uses "Markdown" with a capital M, but this creates inconsistency:
- Documentation mismatch: The CLI documentation at
docs/src/content/docs/setup/cli.mddescribes the command as "Compile Markdown workflows to GitHub Actions YAML" - Pattern inconsistency: Other commands use lowercase for workflow-related terms (e.g., "agentic workflows")
- Wording difference: The CLI short description says "Markdown to YAML workflows" while documentation says "Markdown workflows to GitHub Actions YAML"
Suggested Fix
Choose one consistent approach and apply it to both CLI and documentation:
Option 1: Match documentation style
Short: "Compile Markdown workflows to GitHub Actions YAML"Option 2: Keep it concise with lowercase
Short: "Compile markdown to YAML workflows"Option 3: Be explicit about workflow type
Short: "Compile agentic workflow markdown to YAML"Impact
This is a minor inconsistency that doesn't affect functionality but could cause confusion when comparing CLI help output with documentation.
Related Files
cmd/gh-aw/main.go(line 169)docs/src/content/docs/setup/cli.md(line 109)
AI generated by CLI Consistency Checker
Metadata
Metadata
Assignees
Labels
automationbugSomething isn't workingSomething isn't workingclidocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers