Skip to content

[cli-consistency] Capitalization inconsistency: "markdown" should be "Markdown" in compile command #3694

@github-actions

Description

@github-actions

Issue Description

Command: gh aw compile
Type: Capitalization inconsistency
Priority: Low (style consistency)

Problem

The compile command uses lowercase "markdown" in its short description, but "Markdown" is a proper noun and should typically be capitalized.

Current Help Text (cmd/gh-aw/main.go:122):

Short: "Compile markdown to YAML workflows",

Suggested Fix

Capitalize "Markdown" as it's a proper noun (the Markdown markup language):

- Short: "Compile markdown to YAML workflows",
+ Short: "Compile Markdown to YAML workflows",

Note

YAML is already correctly capitalized in the same string. For consistency, both markup language names should follow the same capitalization convention.

File to Modify

  • cmd/gh-aw/main.go (line 122)

Additional Context

The long description uses "markdown workflow files" and "markdown files" (lowercase). Consider reviewing if these should also be "Markdown workflow files" for full consistency, though lowercase might be acceptable when used as an adjective.

AI generated by CLI Consistency Checker

Metadata

Metadata

Assignees

No one assigned

    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