Skip to content

优化 hgctl 文档#200

Open
2456868764 wants to merge 1 commit intohigress-group:docusaurus-mainfrom
2456868764:fix-hgctl-install
Open

优化 hgctl 文档#200
2456868764 wants to merge 1 commit intohigress-group:docusaurus-mainfrom
2456868764:fix-hgctl-install

Conversation

@2456868764
Copy link
Copy Markdown

No description provided.

@johnlanni
Copy link
Copy Markdown
Contributor

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

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

@2456868764
Copy link
Copy Markdown
Author

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

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

OK

@CH3CHO
Copy link
Copy Markdown
Collaborator

CH3CHO commented Mar 20, 2025

@2456868764 @johnlanni 这个 PR 是需要继续调整还是可以合并了呢?

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.

3 participants