Skip to content

[cli-consistency] Inconsistent capitalization of "Markdown" in compile command help text #5954

@github-actions

Description

@github-actions

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:

  1. Documentation mismatch: The CLI documentation at docs/src/content/docs/setup/cli.md describes the command as "Compile Markdown workflows to GitHub Actions YAML"
  2. Pattern inconsistency: Other commands use lowercase for workflow-related terms (e.g., "agentic workflows")
  3. 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

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions