Write beginner friendly documentation for HTTP client
Open
Nobody has claimed this yet.
1 - triaged
t:docs
- Dominant language
- Scala
- Stars
- 1.4k
- Forks
- 584
- Avg merge
- 14h 33m
- Merged PRs (30d)
- 24
Description
Wednesday Feb 11, 2015 at 14:05 GMT
Originally opened as https://github.com/akka/akka/issues/16859
Migrated from spray/spray#676 which contains several ideas about how to improve the existing (spray) documentation and what beginners would expect when starting with an HTTP client API.
/cc @sirthias
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing HTTP client documentation and the ideas in spray/spray#676, which this issue identifies as the source of requirements. Agree on beginner scenarios and completion criteria with maintainers before editing; done means the documentation explains how newcomers use the HTTP client API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100