typelevel / typelevel/sbt-typelevel
RFC: link to Sonatype-hosted Scaladocs instead of javadoc.io?
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 185
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
We are in the midst of a 2-day+ javadoc.io outage, see https://github.com/maxcellent/javadoc.io/issues/180. This is not the first time unfortunately 😕
We currently use javadoc.io URLs by default both for inter-API linking and also on documentation websites.
However, because we are publishing our docs to Sonatype/Maven, they are also available at a Sonatype-hosted URL. For example:
We might consider switching to using the Sonatype URLs in all the places.
Pros:
- these URLs should be as permanent and live as Sonatype itself i.e. so long as our code artifacts are accessible there, the docs should be as well.
Cons:
- no fancy version picker
- it seems a bit slower (not to say javadoc.io can't be slow sometimes too).
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 locating where sbt-typelevel constructs the default javadoc.io URLs for inter-API links and documentation websites. Compare those call sites with the Sonatype-hosted URL format in the issue, then determine the expected behavior for version navigation and confirm that generated links remain usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100