Emphasise singleRequest more in docs
Open
1 - triaged
t:docs
- Dominant language
- Scala
- Stars
- 1.4k
- Forks
- 584
- Avg merge
- 14h 33m
- Merged PRs (30d)
- 24
Description
**Issue by [ktoso](https://github.com/ktoso)**
_Monday Mar 14, 2016 at 22:20 GMT_
_Originally opened as https://github.com/akka/akka/issues/20030_
---
As it's the simplest and most likely the API most people should be using.
Currently docs come in order from "lowest level to" "request level", which noone understands that that is the "simple one".
Contributor guide
Research direction
Start by locating the documentation that describes the request APIs and reviewing how singleRequest is currently presented relative to lower-level and request-level APIs. Done means the docs clearly emphasize singleRequest as the simplest, recommended API and make its intended use obvious.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100