akka/akka-core

Use sbt-paradox-apidoc

Open

#25,532 opened on Aug 27, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

To share this code with, at least, akka-http.

Contributor guide

Research direction
Investigate how to configure the sbt paradox apidoc plugin in the build system (build.sbt) and generate API documentation. Look at existing usage in akka http as a reference for configuration and integration.
Tech stack
scala
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
ScalaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45