scala / scala3

The Scala 3 compiler, also known as Dotty.
https://dotty.epfl.ch
Apache License 2.0
5.81k stars 1.05k forks source link

Scaladoc: possibility to verify links in docs #16229

Open KacperFKorban opened 1 year ago

KacperFKorban commented 1 year ago

Scaladoc should be able to verify the correctness of links in docstrings and static sites.

Motivation: It's hard to check the correctness of links manually when changing the documentation. e.g.

https://dotty.epfl.ch/api/scala/runtime/stdLibPatches/language$$unsafeNulls$.html# points to http://dotty.epfl.ch/docs/reference/other-new-features/explicit-nulls.html which has been moved to https://dotty.epfl.ch/docs/reference/experimental/explicit-nulls.html

We should be able to detect incorrect links (usually pointing to 404) when generating scaladoc.

Some thoughts:

Dedelweiss commented 1 year ago

Hello @szymon-rd, I saw that you are currently assigned to this issue. I have started working on this problem and I just wanted to know if you had started anything?

szymon-rd commented 1 year ago

Hi, no, I did not start working on it.