jenkinsci / jenkinsci/java-client-api
Bad documentation
Open
enhancement
- Dominant language
- Java
- Stars
- 913
- Forks
- 466
- PR merge metrics
- No merged PRs in 30d
Description
The http://jenkinsci.github.io/java-client-api/ link leads to a boilerplate, useless website.
How about instead, we publish the javadocs online, so that users can navigate the available classes more quickly?
Contributor guide
Research direction
Start by checking the current project build and documentation-publishing entry points, then compare the generated output with the boilerplate site at http://jenkinsci.github.io/java-client-api/. Done means the public link serves navigable Java API documentation covering the available classes instead of the boilerplate page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100