Skip to content

Fix capitalization inconsistency in compile command documentation - #5654

Merged
pelikhan merged 3 commits into
mainfrom
copilot/fix-capitalization-inconsistent
Dec 6, 2025
Merged

Fix capitalization inconsistency in compile command documentation#5654
pelikhan merged 3 commits into
mainfrom
copilot/fix-capitalization-inconsistent

Conversation

CopilotAI commented Dec 6, 2025

Copy link
Copy Markdown
Contributor

The compile command documentation used lowercase "markdown" while the CLI code consistently uses capitalized "Markdown" when referring to the markup language.

Changes:

  • Updated docs/src/content/docs/setup/cli.md line 108: "Compile markdown workflows" → "Compile Markdown workflows"

This aligns with the CLI's consistent capitalization pattern (e.g., "Compile Markdown to YAML workflows", "Create a new workflow Markdown file") and the standard practice of capitalizing "Markdown" when referring to the markup language itself.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Capitalization inconsistency in compile command documentation</issue_title>
<issue_description>## Issue Description

The compile command has a minor capitalization inconsistency between the CLI code and documentation.

Current Behavior

CLI Code (cmd/gh-aw/main.go line 169):

Short: "Compile Markdown to YAML workflows"

Documentation (docs/src/content/docs/setup/cli.md line 106):

#### `compile`
Compile markdown workflows to GitHub Actions YAML

The CLI uses "Markdown" (capitalized) while the documentation uses "markdown" (lowercase).

Expected Behavior

Both should use "Markdown" (capitalized) for consistency.

Evidence

Other commands in the codebase consistently use "Markdown" capitalized:

From new command (cmd/gh-aw/main.go line 59):

Short: "Create a new workflow Markdown file with example configuration"

From compile Long description (cmd/gh-aw/main.go line 170):

Long: `Compile one or more Markdown workflow files to YAML workflows.

The standard practice is to capitalize "Markdown" when referring to the markup language.

Impact

Low - This is a minor documentation inconsistency that doesn't affect functionality.

Suggested Fix

Update line 106 in docs/src/content/docs/setup/cli.md:

-Compile markdown workflows to GitHub Actions YAML+Compile Markdown workflows to GitHub Actions YAML

Priority

Low - Minor documentation consistency issue.

AI generated by CLI Consistency Checker

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 2 commits December 6, 2025 07:31
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan
pelikhan requested a review from CopilotDecember 6, 2025 07:35
@pelikhan
pelikhan marked this pull request as ready for review December 6, 2025 07:35
CopilotAI changed the title [WIP] Fix capitalization inconsistency in compile command documentationFix capitalization inconsistency in compile command documentationDec 6, 2025
CopilotAI requested a review from pelikhanDecember 6, 2025 07:36
@pelikhan
pelikhan merged commit 1a643c3 into mainDec 6, 2025
9 checks passed
@pelikhan
pelikhan deleted the copilot/fix-capitalization-inconsistent branch December 6, 2025 07:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This WIP PR addresses a minor capitalization inconsistency in the CLI documentation by correcting "markdown" to "Markdown" when referring to the markup language, aligning the documentation with the source code conventions.

  • Capitalizes "Markdown" in the compile command documentation (line 108)
  • Updates pinned commit hashes for actions/create-github-app-token@v2 in workflow lock files

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

FileDescription
docs/src/content/docs/setup/cli.mdCapitalizes "Markdown" in the compile command description to match source code conventions
.github/workflows/daily-file-diet.lock.ymlUpdates pinned commit hash for actions/create-github-app-token action in comments and usage
.github/workflows/changeset.lock.ymlUpdates pinned commit hash for actions/create-github-app-token action in comments and usage
.github/workflows/artifacts-summary.lock.ymlUpdates pinned commit hash for actions/create-github-app-token action in comments and usage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] Capitalization inconsistency in compile command documentation

3 participants

@pelikhan