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 (1,961 stars) (219 forks)batch import
help wanted

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

Tech stack
scalagraphql
Domain
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Scala knowledgefamiliarity with documentation workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the source files for the main documentation website, typically in a docs/ folder or a separate repository. Identify where the navigation or links are defined (e.g., in HTML, Markdown, or a static site generator config). Add a link to the scaladoc/javadoc (https://javadoc.io/static/org.sangria graphql/sangria 2.12/2.1.2/index.html) in a prominent location, such as the header or a dedicated 'API Documentation' section. Ensure the link is properly formatted and tested locally.