Skip to content

Scaladoc: possibility to verify links in docs #16229

Open
@KacperFKorban

Description

@KacperFKorban

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:

  • This should be under a flag possibly, since making HTTP calls should definitely not be a default behavior for a doctool
  • We should detect changes in the static site inside of the same repo

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions