Skip to content

Commit 005b3e5

Browse files
authored
Clarify the purpose of the website https://dotty.epfl.ch (#17529)
Relates to #15111
2 parents cbf1f18 + e777aa5 commit 005b3e5

File tree

8 files changed

+10
-21
lines changed

8 files changed

+10
-21
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
Firstly, thanks for being willing to contribute to Dotty! Head on over the
44
[Scala 3 Contributing
5-
Guide](https://docs.scala-lang.org/scala3/guides/contribution/contribution-intro.html), which should have all the info you're looking for.
5+
Guide](https://dotty.epfl.ch/docs/contributing/index.html), which should have all the info you're looking for.

docs/_blog/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: static-site-main
3-
title: Blog
3+
title: Blog (archive)
44
---
55
<main class="container">
66
<h1>{{ page.title }}</h1>

docs/_docs/contributing/architecture/phases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ These map the transformed trees to Java classfiles or SJSIR files.
105105
[patternMatcher]: https://github.com/lampepfl/dotty/blob/master/compiler/src/dotty/tools/dotc/transform/PatternMatcher.scala
106106
[erasure]: https://github.com/lampepfl/dotty/blob/master/compiler/src/dotty/tools/dotc/transform/Erasure.scala
107107
[Mirror]: https://github.com/lampepfl/dotty/blob/master/library/src/scala/deriving/Mirror.scala
108-
[PCP]: {{ site.scala3ref }}/metaprogramming/macros.html#the-phase-consistency-principle
108+
[PCP]: ../../reference/metaprogramming/macros.md#the-phase-consistency-principle

docs/_docs/contributing/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ The main development discussion channels are:
134134
[java8]: https://www.oracle.com/java/technologies/javase-jdk8-downloads.html
135135
[java11]: https://www.oracle.com/java/technologies/javase-jdk11-downloads.html
136136
[adopt]: https://adoptopenjdk.net/
137-
[compat]: /overviews/jdk-compatibility/overview.html
137+
[compat]: https://docs.scala-lang.org/overviews/jdk-compatibility/overview.html
138138
[scala-cla]: https://www.lightbend.com/contribute/cla/scala
139139
[dotty-issue]: https://github.com/lampepfl/dotty/issues
140140
[dotty-discussion]: https://github.com/lampepfl/dotty/discussions

docs/_docs/contributing/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ if you notice anything out of date, or report any issues
1919
### Get the Most from This Guide
2020

2121
`dotc` is built with Scala 3, fully utilising its [new
22-
features](/scala3/new-in-scala3.html). It is recommended that you first have
22+
features](https://docs.scala-lang.org/scala3/new-in-scala3.html). It is recommended that you first have
2323
some familiarity with Scala 3 to get the most out of this guide. You can learn
24-
more in the [language reference]({{ site.scala3ref }}).
24+
more in the [language reference](../reference/overview.md).
2525

2626
Many code snippets in this guide make use of shell commands (a line beginning
2727
with `$`), and in this case a `bash` compatible shell is assumed. You may have

docs/_docs/contributing/workflow.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ The basics of working with Dotty codebase are documented [here](https://dotty.ep
115115
| `testOnly dotty.tools.dotc.CompilationTests -- *pos` | Run test (method) `pos` from `CompilationTests` suite. |
116116
| `testCompilation sample` | In all test suites, run test files containing the word `sample` in their title. |
117117
| `scala3-compiler/Test/runMain dotty.tools.printTypes`| Print types underlying representation |
118+
| `scaladoc/generateScalaDocumentation` | Build the documentation website (published to https://dotty.epfl.ch) |
119+
| `scaladoc/generateReferenceDocumentation` | Build the reference documentation website (published to https://docs.scala-lang.org/scala3/reference) |
118120

119121

120122
## Shell Commands

docs/_docs/index.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
---
22
layout: index
33
redirectFrom: /docs/index.html
4-
nightlyOf: https://docs.scala-lang.org/scala3/reference/
54
---
65

7-
Dotty is the project name for technologies that are considered for inclusion in Scala 3. Scala has
8-
pioneered the fusion of object-oriented and functional programming in a typed setting. Scala 3 will
9-
be a big step towards realizing the full potential of these ideas. Its main objectives are to
10-
11-
- become more opinionated by promoting programming idioms we found to work well,
12-
- simplify where possible,
13-
- eliminate inconsistencies and surprising behaviors,
14-
- build on strong foundations to ensure the design hangs well together,
15-
- consolidate language constructs to improve the language’s consistency, safety, ergonomics, and performance.
16-
17-
In this documentation you will find information on how to use the Dotty compiler on your machine,
18-
navigate through the code, setup Dotty with your favorite IDE and more!
19-
6+
This website contains the developer documentation of the Scala 3 compiler. It targets developers interested in contributing to the compiler, or learning its internals. If you want to learn how to use Scala, go [here](https://docs.scala-lang.org/).

docs/_docs/reference/metaprogramming/macros-spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Quotes define all the `Expr[T]` methods as extension methods.
134134
`Type[T]` does not have methods and therefore does not appear here.
135135
These methods are available as long as `Quotes` is implicitly given in the current scope.
136136

137-
The `Quotes` instance is also the entry point to the [reflection API](./refelction.md) through the `reflect` object.
137+
The `Quotes` instance is also the entry point to the [reflection API](./reflection.md) through the `reflect` object.
138138

139139
Finally, `Quotes` provides the internal logic used in quote un-pickling (`QuoteUnpickler`) in quote pattern matching (`QuoteMatching`).
140140
These interfaces are added to the self-type of the trait to make sure they are implemented on this object but not visible to users of `Quotes`.

0 commit comments

Comments
 (0)