akka/akka-core

Scaladoc/Javadoc links

Open

#22,904 opened on May 11, 2017

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
3 - in progresshelp wantedt:docs

Repository metrics

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

Description

We should make use of http://developer.lightbend.com/docs/paradox/latest/features/linking.html#scaladoc-directive

This task is not top priority, can be added after first release.

Contributor guide

Research direction
Learn about the paradox Scaladoc directive and add links to ScalaDoc/Javadoc in the Akka documentation site.
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.
Clear
Prerequisites
GitParadoxScaladoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70