Skip to content

docs: standardize GitHub Actions capitalization - #6367

Merged
yiliang114 merged 1 commit into
QwenLM:mainfrom
guiyang882:docs/github-actions-branding
Jul 6, 2026
Merged

docs: standardize GitHub Actions capitalization#6367
yiliang114 merged 1 commit into
QwenLM:mainfrom
guiyang882:docs/github-actions-branding

Conversation

@guiyang882

Copy link
Copy Markdown
Contributor

What this PR does

Standardizes the capitalization of GitHub Actions in the documentation.

Why it's needed

This keeps the GitHub Actions product name consistent with GitHub's brand spelling and removes a small documentation mismatch.

Reviewer Test Plan

How to verify

Confirm the affected documentation uses GitHub Actions consistently. I verified the docs formatting and project checks locally.

npx prettier --check docs/developers/roadmap.md docs/users/integration-github-action.md
npm run build
npm run typecheck

Evidence (Before & After)

N/A - docs-only capitalization fix.

Tested on

OS Status
🍏 macOS ✅ tested
🪟 Windows N/A
🐧 Linux N/A

Environment (optional)

Local npm workspace with dependencies installed via npm install.

Risk & Scope

  • Main risk or tradeoff: Very low; this changes documentation text only.
  • Not validated / out of scope: I did not run a docs-site visual preview.
  • Breaking changes / migration notes: None.

Linked Issues

Closes #6366

中文说明

What this PR does

统一文档中 GitHub Actions 的大小写写法。

Why it's needed

这能让 GitHub Actions 产品名和 GitHub 的品牌写法保持一致,并消除一个很小的文档不一致问题。

Reviewer Test Plan

How to verify

确认相关文档统一使用 GitHub Actions。我已在本地验证文档格式和项目检查。

npx prettier --check docs/developers/roadmap.md docs/users/integration-github-action.md
npm run build
npm run typecheck

Evidence (Before & After)

N/A - 仅文档大小写修正。

Tested on

OS Status
🍏 macOS ✅ tested
🪟 Windows N/A
🐧 Linux N/A

Environment (optional)

本地 npm workspace,依赖通过 npm install 安装。

Risk & Scope

  • Main risk or tradeoff: 风险很低,仅修改文档文本。
  • Not validated / out of scope: 未运行 docs-site 可视化预览。
  • Breaking changes / migration notes: 无。

Linked Issues

Closes #6366

@qwen-code-ci-bot

Copy link
Copy Markdown
Collaborator

Thanks for the PR!

Template looks good ✓

Problem: Real and observable — the project's docs mostly use the correct branding "GitHub Actions", but two files had the incorrect "Github Actions". This is a legitimate inconsistency.

Direction: Aligned. Docs branding consistency is a clear win, zero risk.

Approach: Minimal — 2 lines changed, both fixing the exact capitalization issue. Nothing extraneous. The diff is clean and focused.

Moving on to doc verification. 🔍

中文说明

感谢贡献!

模板完整 ✓

问题:真实可观测——项目文档大部分地方正确使用 "GitHub Actions",但有两处文件写成了 "Github Actions",属于实际存在的不一致。

方向:对齐。文档品牌一致性是明确的改进,零风险。

方案:最小化——仅改动 2 行,全部修复目标大小写问题,无多余内容。Diff 干净聚焦。

进入文档验证 🔍

Qwen Code · qwen3.7-max

@qwen-code-ci-bot

Copy link
Copy Markdown
Collaborator

Code Review

The diff is exactly what the PR describes — two instances of "Github Actions" corrected to "GitHub Actions":

  • docs/developers/roadmap.md: table row label fix
  • docs/users/integration-github-action.md: H1 heading fix

No code logic touched. No unrelated changes.

A quick grep confirms these were the only two remaining "Github Actions" instances in docs/ — all other files already use the correct "GitHub Actions" branding. After this PR, the docs are consistent.

Verification

  • Prettier check on both changed files: ✅ All matched files use Prettier code style
  • Tmux real-user testing: N/A — docs-only capitalization fix, no TUI or runtime behavior affected
$ npx prettier --check docs/developers/roadmap.md docs/users/integration-github-action.md
Checking formatting...
All matched files use Prettier code style!
中文说明

代码审查

Diff 与 PR 描述完全一致——两处 "Github Actions" 修正为 "GitHub Actions":

  • docs/developers/roadmap.md:表格行标签修复
  • docs/users/integration-github-action.md:H1 标题修复

未触及任何代码逻辑,无无关改动。

通过 grep 确认这是 docs/ 中仅剩的两处 "Github Actions",其余文件均已正确使用 "GitHub Actions"。合并后文档品牌写法将完全一致。

验证

  • Prettier 检查:✅ 通过
  • Tmux 真实用户测试:不适用——纯文档大小写修复,不影响 TUI 或运行时行为

Qwen Code · qwen3.7-max

@qwen-code-ci-bot

Copy link
Copy Markdown
Collaborator

Straightforward docs fix. The problem is real (two remaining "Github Actions" instances in an otherwise consistent codebase), the fix is minimal (exactly those two lines), and prettier passes. Nothing to object to.

Approving. ✅

中文说明

简洁的文档修复。问题真实存在(代码库中仅剩两处 "Github Actions",其余均正确),修复最小化(恰好修改这两处),Prettier 检查通过。没有反对理由。

批准。✅

Qwen Code · qwen3.7-max

@qwen-code-ci-bot qwen-code-ci-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, looks ready to ship. ✅

@qwen-code-ci-bot qwen-code-ci-bot added scope/github-actions GitHub Actions integration skip-changelog Exclude from release notes type/documentation Documentation improvements or additions labels Jul 6, 2026

@qwen-code-ci-bot qwen-code-ci-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The two "Github Actions" → "GitHub Actions" changes are correct and consistent. Prettier formatting passes. A few additional capitalization instances were found outside this PR's diff:

[Suggestion] docs/users/extension/extension-releasing.md has 3 remaining "Github" instances that could be included for a complete cleanup:

  • Line 6: [Github Releases][GitHub Releases]
  • Line 9: Github releases may also contain...GitHub releases may also contain...
  • Line 33: ## Releasing through Github releases## Releasing through GitHub releases

[Suggestion] docs/users/integration-github-action.md line 136 (inside the <!-- BEGIN_AUTOGEN_INPUTS --> block) has lowercase github action — "Whether to upload artifacts to the github action." This requires fixing the upstream source that generates this block, not the markdown directly.

— qwen3.7-max via Qwen Code /review

@yiliang114
yiliang114 added this pull request to the merge queue Jul 6, 2026
Merged via the queue into QwenLM:main with commit 6f2f21f Jul 6, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope/github-actions GitHub Actions integration skip-changelog Exclude from release notes type/documentation Documentation improvements or additions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: standardize GitHub Actions capitalization

3 participants