Skip to content

[cli-consistency] Inconsistent "Markdown" capitalization in compile command description #7499

@github-actions

Description

@github-actions

Issue Description

Command: gh aw compile
Type: Capitalization inconsistency
Priority: Low

Current Output (from cmd/gh-aw/main.go, line 172)

Short: "Compile agentic workflow Markdown to GitHub Actions YAML"

Issue

The command description uses capitalized "Markdown" which is correct according to the capitalization test in cmd/gh-aw/capitalization_test.go (line 72-89). However, the root command description (line 38) uses lowercase "markdown":

Long: `GitHub Agentic Workflows from GitHub Next

Common Tasks:
  gh aw init                  # Set up a new repository
  gh aw new my-workflow       # Create your first workflow
  gh aw compile               # Compile all workflows    ← says "workflows" not "markdown"

Suggested Fix

Ensure consistency in terminology:

  • Root command description should say "Compile Markdown workflows" to match the compile command's full description
  • OR change to "Compile workflow files to GitHub Actions YAML" to be more generic

This aligns with the technical terms capitalization test which requires "Markdown" to be capitalized (not "markdown").

AI generated by CLI Consistency Checker

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions