akka/akka-core

Scaladoc/Javadoc links

Open

#22,904 opened on May 11, 2017

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

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

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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalasbtParadox
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the project's documentation setup, typically using Paradox with SBT. Locate the documentation source files (e.g., in a docs/ directory) and add @scaladoc or @javadoc directives as described at http://developer.lightbend.com/docs/paradox/latest/features/linking.html#scaladoc directive. After adding directives, run the documentation build to verify links render correctly.