slackapi / slackapi/java-slack-sdk
Some links in Javadoc pages are not working
Open
Nobody has claimed this yet.
docs
- Dominant language
- Java
- Stars
- 602
- Forks
- 232
- Avg merge
- 4d 9h
- Merged PRs (30d)
- 7
Description
Issue Type
- Bug
- Enhancement / Feature request
- Question
- Documentation
Description
When accessing the Javadoc websites hosted by Sonatype, the links to classes in other packages of this SDK are invalid. We need to revisit the way to generate Javadoc files to be compatible with the Sonatype's Javadoc hosting service.
Requirements (place an x in each of the [ ])
- I've read and understood the Contributing guidelines and have done my best effort to follow them.
- I've read and agree to the Code of Conduct.
- I've searched for any related issues and avoided creating a duplicate issue.
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
Start by opening the linked Sonatype Javadoc page and checking a broken link to a class in another package. Then trace the project's Javadoc generation configuration and compare the generated links with Sonatype's hosting format. Done means cross-package links in the hosted Javadocs resolve correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100