hugapi/hug

hug needs more documentation

Open

#319 opened on May 25, 2016

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

Repository metrics

Stars
 (6,758 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Contribute to documentation by adding FAQ, best practices, or example starting points for the hug API framework.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90