Skip to content

Remove source files in _scala3-reference/ #2391

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

Merged
merged 2 commits into from
May 9, 2022

Conversation

julienrf
Copy link
Contributor

@julienrf julienrf commented May 5, 2022

Initially, the Dotty documentation used to be published on the website https://dotty.epfl.ch. When Dotty became Scala 3.0.0, it was natural to move its documentation here, on the website https://docs.scala-lang.org (see #2112). However, by doing so we realized that the compiler team lost the ability to implement something in the compiler and to document it in a single pull request. They now had to implement their features in the dotty repo, and to document these features here.

I believe the Scala 3 reference documentation should be hosted on the website docs.scala-lang.org, but I also understand that it is more convenient for the compiler team if they can implement things and document their work within a single repo. Consequently, we decided with VirtusLab to produce the HTML pages of the Scala 3 reference documentation from source files hosted on the dotty repo. These pages are published at the URL https://docs.scala-lang.org/scala3/reference, so they “shadow” any content produced by the docs.scala-lang repo. Therefore, we should remove the duplicated source files from this repo.

@julienrf julienrf force-pushed the remove-scala3-reference branch 2 times, most recently from 2aaf399 to 2afd089 Compare May 5, 2022 12:57
@julienrf julienrf force-pushed the remove-scala3-reference branch from 2afd089 to d1072f0 Compare May 5, 2022 13:02
@bishabosha
Copy link
Member

some links need updating

@julienrf julienrf force-pushed the remove-scala3-reference branch 2 times, most recently from 3dceb1a to 6eda267 Compare May 5, 2022 14:15
@bishabosha
Copy link
Member

bishabosha commented May 5, 2022

one more

Ran on 1090 files!
- ./_site/scala3/book/ca-summary.html
  *  External link https://docs.scala-lang.org/scala3/reference/contextual.html failed: 404 No error

@julienrf julienrf force-pushed the remove-scala3-reference branch 3 times, most recently from 725e189 to b6a9755 Compare May 5, 2022 14:53
@julienrf julienrf force-pushed the remove-scala3-reference branch from b6a9755 to 763d518 Compare May 5, 2022 15:08
@bishabosha bishabosha marked this pull request as ready for review May 5, 2022 16:05
@julienrf julienrf merged commit da2e086 into scala:main May 9, 2022
@julienrf julienrf deleted the remove-scala3-reference branch May 9, 2022 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants