akka/akka-http

Improve Scaladoc package documentation

Open

#577 opened on Nov 22, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

We will now link to the scaladsl package directly. We should have some documentation pointers there to guide people where to look further. Right now it is empty.

Contributor guide

Research direction
Add documentation pointers to the scaladsl package's Scaladoc page to guide users where to look for further information. Currently the page is empty after the move.
Tech stack
scala
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.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80