Skip to content

[cli-consistency] Inconsistent "Markdown" capitalization in CLI help text #3701

@github-actions

Description

@github-actions

Issue Description

Command: Multiple commands (new, compile)
Type: Inconsistent capitalization
Priority: Low

Current Output (from source code)

In cmd/gh-aw/main.go:

Line 45 (new command Short description):

Create a new workflow markdown file with example configuration

Line 46 (new command Long description):

Create a new workflow markdown file with commented examples and explanations...

Line 122 (compile command Short description):

Compile Markdown to YAML workflows

Line 123 (compile command Long description):

Compile one or more markdown workflow files to YAML workflows.

Issue

The word "Markdown" is inconsistently capitalized:

  • In the new command: lowercase "markdown"
  • In the compile command Short description: capitalized "Markdown"
  • In the compile command Long description: lowercase "markdown"

Suggested Fix

"Markdown" is a proper noun (the name of a markup language) and should be consistently capitalized throughout all help text.

Recommended changes:

  • Line 45: "Create a new workflow Markdown file with example configuration"
  • Line 46: "Create a new workflow Markdown file with commented examples..."
  • Line 123: "Compile one or more Markdown workflow files to YAML workflows."

Files Affected

  • cmd/gh-aw/main.go (lines 45, 46, 123)

AI generated by CLI Consistency Checker

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions