-
Notifications
You must be signed in to change notification settings - Fork 464
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.
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
Proposal(hz): Add a docs
folder to the output of "hz new" command for better onboarding experience
#613
Comments
I think optimizing |
But does hz -help already exist? Its appearance is not as good compared to providing a searchable documentation. 但是 hz -help 已经存在对吗? 它和提供一个可查阅的文档比, 它的观感不是很好 |
It feels a little redundant to generate such a document every time. For example, each of my microservices corresponds to a Hertz service, so I will generate several such documents. Maybe we make 每次都会产生一个这样的文档感觉会有一点冗余,例如我每一个微服务都对应一个 Hertz 的服务,那么我会生成好几个这样的文档。也许可以使 |
How about adding an option to choose whether to generate docs or not? 那加一个选项用于选择是否生成docs怎么样 |
Actually, the documentation could also include an introduction to and links for community-provided middleware, similar to what is done in the hertz README, to make it easier for users to utilize. 实际上文档中还可以像 hertz 的 README 一样,加入社区提供的中间件介绍和链接,以方便用户使用。 |
我认为可以在 hz 生成代码中添加一个 readme 用于介绍 hz 的用法以及常见扩展 |
@Skyenought any process? |
@li-jin-gou yes, wait me make PR |
Is your feature request related to a problem? Please describe.
Users currently need to browse the web to find information on how to use the hz tool for generating hertz code in a project. This is not convenient and may make it difficult for new users to get started with hz without any guidance or instructions.
用户需要浏览网页来获取有关如何在项目中使用 hz 工具生成 hertz 代码的信息。这不太方便,可能会使没有任何指导或说明的新用户很难开始使用 hz。
Describe the solution you'd like
I would like to propose adding a
docs
folder to the initial hz code generated by thehz new
command. This folder would contain a user guide and instructions on how to use hz to generate hertz code. This would make it much easier for new users to get started with hz and provide them with clear instructions and guidance.我建议在
hz new
命令生成的初始 hz 代码中添加一个docs
文件夹。这个文件夹将包含用户指南和说明,指导用户如何使用 hz 生成 hertz 代码。这将使新用户更容易入门 hz,并为他们提供清晰的说明和指导。Describe alternatives you've considered
Additional context
I believe that adding this feature would improve the usability and accessibility of hz for new users, and would help to make hertz a more widely used and popular web framework in the Go community.
我相信添加这个功能将提高 hz 对新用户的可用性和易用性,并有助于使 hertz 成为 Go 社区中更广泛使用和受欢迎的 Web 框架。
The text was updated successfully, but these errors were encountered: