akka / akka/akka-http

Improve Scaladoc package documentation

Open
#577 1 comment 0 reactions 0 assignees View on GitHub
1 - triaged help wanted t:docs
Dominant language
Scala
Stars
1.4k
Forks
584
Avg merge
14h 33m
Merged PRs (30d)
24

Description

We will now link to the scaladsl package directly. We should have some documentation pointers there to guide people where to look further. Right now it is empty.

Contributor guide

Open the contributing guide

Research direction

Locate the Scaladoc entry point for the scaladsl package and inspect how nearby package documentation is written. Add documentation pointers that guide readers to further information, then verify that the generated scaladoc package page is no longer empty and the links lead to relevant documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.