Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

优化 hgctl 文档 #200

Open
wants to merge 1 commit into
base: docusaurus-main
Choose a base branch
from
Open

优化 hgctl 文档 #200

wants to merge 1 commit into from

Conversation

2456868764
Copy link
Contributor

No description provided.

@johnlanni
Copy link
Contributor

一点建议，看是否可以简单调整优化下：

  1. 目前hgctl的功能很多，可以在文档开头列举一下hgctl可以做哪些事情，然后加锚点链接到下面的段落中
  2. 每个功能段落尽量简单，有一个example说明如何使用即可，详细的可以让用户看help命令的输出
  3. profile的说明比较复杂，大部分用户使用默认的最佳实践配置即可，其实不需要关心，建议放在文章最后

@2456868764
Copy link
Contributor Author

一点建议，看是否可以简单调整优化下：

  1. 目前hgctl的功能很多，可以在文档开头列举一下hgctl可以做哪些事情，然后加锚点链接到下面的段落中
  2. 每个功能段落尽量简单，有一个example说明如何使用即可，详细的可以让用户看help命令的输出
  3. profile的说明比较复杂，大部分用户使用默认的最佳实践配置即可，其实不需要关心，建议放在文章最后

OK

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

@laojun laojun Awaiting requested review from laojun laojun is a code owner

@CH3CHO CH3CHO Awaiting requested review from CH3CHO CH3CHO is a code owner

@slievrly slievrly Awaiting requested review from slievrly slievrly is a code owner

@johnlanni johnlanni Awaiting requested review from johnlanni johnlanni is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@2456868764 @johnlanni