Skip to content

Scaladoc documentation content is duplicated with https://docs.scala-lang.org/scala3/guides/scaladoc/ #15113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
julienrf opened this issue May 5, 2022 · 1 comment · Fixed by #15169
Assignees
Labels
area:documentation itype:enhancement stat:unassigned This issue or PR is not assigned to anyone, but should be

Comments

@julienrf
Copy link
Contributor

julienrf commented May 5, 2022

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 julienrf added itype:enhancement area:documentation stat:unassigned This issue or PR is not assigned to anyone, but should be labels May 5, 2022
@pikinier20 pikinier20 self-assigned this May 6, 2022
@julienrf
Copy link
Contributor Author

julienrf commented Jul 5, 2022

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

@julienrf julienrf closed this as completed Jul 5, 2022
@julienrf julienrf linked a pull request Jul 5, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation itype:enhancement stat:unassigned This issue or PR is not assigned to anyone, but should be
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants