akka/akka-http

Allow linking to javadoc members

Open

#2,073 opened on Jun 14, 2018

View on GitHub
 (0 comments) (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

This requires some additional script to be included in the javadocs, which Lagom successfully does as described at https://github.com/lightbend/paradox/pull/160/files#r144705425

Contributor guide

Research direction
Study the referenced PR (lightbend/paradox#160) to understand the required script inclusion. Then implement similar script addition in the akka http javadoc generation.
Tech stack
scala
Domain
documentation
Issue type
Feature
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
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60