Skip to content

文档修改 - #715

Merged
fhmmq2025 merged 3 commits into
OpenHUTB:masterfrom
2992838310:docs-fix
Nov 17, 2026
Merged

fhmmq2025 merged 3 commits into
OpenHUTB:masterfrom
2992838310:docs-fix

Conversation

@2992838310

Copy link
Copy Markdown
Contributor

变更内容

简述本次修改做了什么、为什么修改。

  1. 补充遗漏的“单条发布”机制(纠正绝对化表述)
    原句的问题:原句直接跳到了“点击右上角 Submit review”,并且断言“否则评论不会公开显示”。这会让新手误以为在 GitHub 上评论必须经过右上角的汇总弹窗。

修改理由:在 Files changed 页面点击行号的 + 号写评论时,输入框下方其实提供了两个选项:一个是 Start a review(开始审查),另一个是 Add single comment(添加单条评论)。如果点击后者,评论会立刻公开发布,无需去右上角。因此,修改版区分了“单条直接发布”和“多条汇总发布”两种场景。

  1. 纠正 UI 按钮名称及路径错误(层级关系)
    原句的问题:原句说“点击右上角的 Submit review(旧版叫 Review changes)”。实际上,用户点击右上角按钮时,看到的界面并非直接写著 Submit review。

修改理由:当你在左侧添加了评论并选择了 Start a review 后,右上角的按钮名称是 Finish your review(旧版确实是 Review changes)。点击这个按钮后,才会弹出一个窗口(Modal),在这个弹窗的最下方,才是真正的 Submit review 按钮。修改版厘清了“右上角按钮”和“弹窗内最终提交按钮”的先后层级关系。
关联 Issue:Closes #

变更范围

  • 文档内容(markdown)
  • 配置 / 批处理 / 脚本
  • 其他:______

自查清单

  • 仅包含与本次变更相关的文件(无夹带修改)
  • 涉及链接 / 图片路径的目标均已确认存在
  • 配置 / 脚本格式正确,并已在本地验证

社区协作提示:请勿在 PR 中夹带无关文件的修改;修改链接前请确认目标页面真实存在,并在描述中说明链接指向的具体目标。

@zh-yutong

Copy link
Copy Markdown
Contributor

本次修正很有价值。原文档的描述容易让新手误以为GitHub评论只能走右上角汇总弹窗,本次补充了单条发布机制,厘清两种评论模式;同时更正了界面按钮名称、操作层级的偏差,贴合GitHub真实交互逻辑,有效降低读者踩坑概率,描述清晰,可合并。

Signed-off-by: 2992838310 <2992838310@qq.com>
@Wander-Buck

Copy link
Copy Markdown
Contributor

可以

@fhmmq2025
fhmmq2025 merged commit d19f73c into OpenHUTB:master Nov 17, 2026
1 check passed
@wdq996

wdq996 commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

可以可以

Sign up for free to 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.

5 participants