hugapi/hug

hug needs more documentation

Open

#319 创建于 2016年5月25日

在 GitHub 查看
 (10 评论) (8 反应) (0 负责人)Python (6,758 star) (389 fork)batch import
bugenhancementhelp wanted

描述

hug has a collection of documentations on hug.rest and on the github repo (including examples etc) which has served as a reasonable starting point. However, for continued growth, a wider depth of and a higher quality of documentation is an absolute necessity and it is the number 1 priority for the project.

Feel free to add any ideas for additional documentation sources that could be useful for the project to this issue. The currently known ones are:

  • FAQ
  • Known Issues / Gotchas
  • Best Practices
  • Example starting points
  • Full documentation for all exposed APIs and features

I, and the entire community, would be grateful for any help in this area.

Thanks!

~Timothy

贡献者指南

技术栈
pythonrest api
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Python basicsFamiliarity with hugMarkdownWriting clear docs
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Start by exploring the existing documentation on hug.rest and the GitHub repo to understand what is already covered. Then choose one area from the list (e.g., FAQ or Best Practices) and create a new document or update existing ones. Consider opening a discussion in the issue to coordinate with others. Refer to the issue comments for any suggestions already made.
hug needs more documentation · hugapi/hug#319 | Good First Issue