sangria-graphql/sangria

Main documentation seems to not link to scaladoc / javadoc

Open

#880 opened on Jun 14, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Scala (219 forks)batch import
help wanted

Repository metrics

Stars
 (1,961 stars)
PR merge metrics
 (Avg merge 8d 15h) (4 merged PRs in 30d)

Description

Ideally, the main documentation should link to the API documentation, e.g. https://javadoc.io/static/org.sangria-graphql/sangria_2.12/2.1.2/index.html

Contributor guide

Research direction
Add links to the scaladoc/javadoc API documentation on the main documentation site.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95