hugapi/hug

hug needs more documentation

Open

#319 opened on May 25, 2016

View on GitHub
 (10 comments) (8 reactions) (0 assignees)Python (6,758 stars) (389 forks)batch import
bugenhancementhelp wanted

Description

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

Contributor guide

Tech stack
pythonrest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python basicsFamiliarity with hugMarkdownWriting clear docs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.