Skip to content

Document better the purpose of the Dotty website #15115

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.

Sign up for GitHub

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

Jump to bottom
Closed
julienrf opened this issue May 5, 2022 · 1 comment · Fixed by #16227
Closed

Document better the purpose of the Dotty website #15115

julienrf opened this issue May 5, 2022 · 1 comment · Fixed by #16227
Assignees
@szymon-rd
Labels
area:documentation good first issue Perfect for someone who wants to get started contributing 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 •
edited
Loading

Currently, the role of the Dotty website is not clear. Its content seems to overlap with the Scala documentation website.

I believe the Dotty website should be used to host the “nightly” documentation only (as opposed to “stable” documentation), and internal documentation for developers of the compiler (see related issues #15110, #15111, and #15113).

  • We should make this role clearer by adding a message about it on the front page, with a link to the stable documentation (https://docs.scala-lang.org).
  • We should add a banner to the top of every page to highlight the fact that the content reflects what is in the nightly state, with a link to the stable documentation (similar to the movedTo property).
@julienrf julienrf added itype:enhancement area:documentation stat:unassigned This issue or PR is not assigned to anyone, but should be good first issue Perfect for someone who wants to get started contributing labels May 5, 2022
@julienrf julienrf mentioned this issue May 9, 2022
Closed
@pikinier20 pikinier20 mentioned this issue May 10, 2022
Merged
@julienrf
Copy link
Contributor Author

I see that currently https://dotty.epfl.ch does not show anymore the information “This is a nightly documentation. The content of this page may not be consistent with the current stable version of language.” It seems that there is a regression and the work done in #15117 has been lost.

@julienrf julienrf reopened this Oct 21, 2022
julienrf added a commit that referenced this issue Oct 21, 2022
@julienrf
Fix “nightly warning”
1308957 
Somehow, part of the work done in #15156 has been reverted. This PR fixes it.

Closes #15115
@julienrf julienrf mentioned this issue Oct 21, 2022
Merged
julienrf added a commit that referenced this issue Oct 21, 2022
@julienrf
Fix “nightly warning” (#16227)
ef962cc 
Somehow, part of the work done in #15156 has been reverted. This PR
fixes it.

Closes #15115
szymon-rd pushed a commit to szymon-rd/scala3 that referenced this issue Nov 16, 2022
@julienrf @szymon-rd
Fix “nightly warning”
05fb271 
Somehow, part of the work done in scala#15156 has been reverted. This PR fixes it.

Closes scala#15115
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@szymon-rd szymon-rd

Labels
area:documentation good first issue Perfect for someone who wants to get started contributing itype:enhancement stat:unassigned This issue or PR is not assigned to anyone, but should be
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix “nightly warning” scala/scala3
3 participants
@julienrf @szymon-rd @pikinier20