akka/akka-core

Paradox directive that can create Java signatures for the documentation

Open

#24,931 opened on Apr 19, 2018

View on GitHub
 (1 comment) (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

Because our javadsl is written in Scala this would need some processing to make it suitable for the Java version of the docs.

Contributor guide

Research direction
Investigate how Paradox documentation works in Akka and understand how Java signatures are currently handled. Look for existing directives in the codebase and consider using Scala's compiler API to extract type information for generating Java compatible signatures.
Tech stack
scalajava
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.
Mostly clear
Prerequisites
ScalaParadox
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60