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 documentation content is duplicated with https://docs.scala-lang.org/scala3/guides/scaladoc/ #15113

Closed julienrf closed 2 years ago

julienrf commented 2 years ago

The Scaladoc documentation at https://dotty.epfl.ch/docs/usage/scaladoc/index.html is redundant (and possibly inconsistent) with the documentation at https://docs.scala-lang.org/scala3/guides/scaladoc/.

We should pick only one source of truth.

I see two different ways to address this issue:

  1. Remove the content from the Dotty website (just use the repo scala/docs.scala-lang to host the sources of the Scaladoc documentation)
  2. Or, remove the source files from the scala/docs.scala-lang repo, generate the HTML pages using Scaladoc itself from the sources that are hosted in the Dotty repo, and publish them to https://docs.scala-lang.org/scala3/scaladoc in a similar way than what we do with the Scala 3 reference documentation.

I believe the first solution would be technically simpler, but I see one issue with it: every time something is added/changed to the Scaladoc implementation, the corresponding update in the documentation would require a separate PR on scala/docs.scala-lang.

The second solution requires more complex machinery.

julienrf commented 2 years ago

I am closing the issue since it has been addressed already. Please @pikinier20 re-open it if I’m wrong.