typetools / typetools/checker-framework
Run the link checker on the manual and on Javadoc in the continuous integration jobs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 440
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 134
Description
Currently broken links in the manual or in Javadoc are discovered by running the release scripts. Broken links in documentation should be discovered immediately by running the link checker in the checker-framework Jenkins and Travis jobs.
Adding link checking to the javadoc target, just for links within the Javadoc-generated HTML, is of value and would address much of the problem. That is, the last step of the javadoc target is to run link checking, telling the link checker to ignore foreign links and only check links that go into the generated Javadoc.
all-tests should run the javadoc target.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the javadoc target, all-tests target, and the checker-framework Jenkins and Travis jobs mentioned in the issue. Start by tracing how the release scripts currently invoke link checking; done means generated Javadoc internal links and the manual are checked by CI, while foreign links are ignored.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100