Skip to content

Commit 1c90444

Browse files
committed
Restructure the top-level doc pages to better highlight the new tutorials.
1 parent 8ae66d5 commit 1c90444

File tree

9 files changed

+64
-71
lines changed

9 files changed

+64
-71
lines changed

_data/doc.yml

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
- text: Introduction
1+
- text: Documentation
22
url: /doc/
3-
#- text: Quick Start
4-
# url: /doc/quick-start.html
53
- text: Tutorials
64
url: /doc/tutorial/
75
subitems:
8-
- text: Basic tutorial
9-
url: /doc/tutorial/basic/
6+
- text: Getting Started with Scala.js and Vite
7+
url: /doc/tutorial/scalajs-vite.html
8+
- text: Build UIs with Laminar
9+
url: /doc/tutorial/laminar.html
10+
- text: Integrate JavaScript libraries with ScalablyTyped
11+
url: /doc/tutorial/scalablytyped.html
1012
- text: Scala.js for JavaScript developers
1113
url: /doc/sjs-for-js/
1214
subitems:

doc/index.md

+11-16
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
11
---
22
layout: doc
3-
title: Introduction
3+
title: Documentation
44
---
55

6-
The bullets on the right link to various facets of the documentation.
6+
# Getting Started
77

8-
If you are coming from a JavaScript background, we've got
9-
[a special tour for you](sjs-for-js/), which will teach you the basics of
10-
Scala.js with respect to JavaScript.
8+
Follow our [Getting Started Tutorials](tutorial/).
119

12-
# Installation
10+
# Installation / Download
1311

14-
All you need to get started is
12+
One does not install or download Scala.js.
13+
It is automatically handled by build tools.
1514

16-
* A recent version of Java JDK [(download)](https://www.oracle.com/java/technologies/downloads/)
17-
* SBT [(download)](https://www.scala-sbt.org/1.x/docs/Setup.html)
15+
If in doubt, follow the [Prerequisites](tutorial/#prerequisites) section of the Getting Started Tutorials.
1816

19-
See the [Basic tutorial](tutorial/basic/) for details about installation and setup.
17+
# Other resources
2018

21-
# Tutorials
22-
23-
Check out one of the [tutorials](tutorial/) to continue your journey!
24-
25-
You may also find the [presentation videos](../community/presentations.html)
26-
a nice way to get started with Scala.js!
19+
* [Presentation videos](../community/presentations.html)
20+
* [Tour of Scala.js for JavaScript developers](sjs-for-js/)
21+
* More in the column on the right of this page
2722

2823
# Get help
2924

doc/tutorial/getting-started/index.md

-44
This file was deleted.

doc/tutorial/index.md

+44-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,51 @@ layout: doc
33
title: Tutorials
44
---
55

6-
Arguably, the most efficient way to learn new technology is to try it out yourself. Here, we have collected a set
7-
of tutorials from simple to complete web app, to get you started right away!
6+
This series of tutorials teaches you how to use Scala.js together with modern development tools.
87

9-
* [Getting Started with Scala.js, Vite, Laminar and ScalablyTyped](./getting-started/)
10-
* [Basic tutorial](./basic/) to get you started
8+
1. [Scala.js and Vite](./scalajs-vite.html):
9+
* Set up a hello world project ready for live reloading in the browser.
10+
* Generate minimized production assets.
11+
2. [Laminar](./laminar.html):
12+
* Build UIs with Laminar using Functional Reactive Programming (FRP), a hybrid model between imperative and functional programming particularly well suited for UI development in Scala.
13+
3. [ScalablyTyped](./scalablytyped.html):
14+
* Integrate JavaScript libraries using ScalablyTyped.
15+
16+
If you have time, reading and applying them in order will give you more in-depth knowledge about the development environment.
17+
18+
If you are in a hurry, you can skip the ones you are not interested in.
19+
Each tutorial starts with a link to a repo that you can clone to get off the ground.
20+
21+
In any case, make sure that you have the prerequisites listed below covered.
22+
23+
## Prerequisites
24+
25+
In any case, make sure that you have the following tools installed first:
26+
27+
* [Scala and its development tools](https://www.scala-lang.org/download/)
28+
* [Node.js](https://nodejs.org/en/download/)
29+
30+
If in doubt, try the following commands in a terminal.
31+
They should all succeed, though the reported version numbers may differ.
32+
33+
{% highlight shell %}
34+
$ node -v
35+
v16.13.0
36+
$ npm -v
37+
8.1.0
38+
$ sbt -version
39+
sbt version in this project: 1.7.3
40+
sbt script version: 1.7.3
41+
{% endhighlight %}
42+
43+
We also recommend that you use an IDE for Scala.
44+
If you do not know what to pick, we recommend [VS Code](https://code.visualstudio.com/download/) with [the Metals extension](https://scalameta.org/metals/docs/editors/vscode/).
45+
46+
## Older tutorials
47+
48+
Here are some older tutorials, which may still provide value:
49+
50+
* The old [basic tutorial](./basic/)
1151
* [Hands-on Scala.js](https://lihaoyi.github.io/hands-on-scala-js), an extensive tutorial in eBook format
1252
* [SPA tutorial](https://github.com/ochrons/scalajs-spa-tutorial) for writing a
1353
Single-Page-Application using React

doc/tutorial/getting-started/laminar.md renamed to doc/tutorial/laminar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: doc
3-
title: Getting Started with Laminar
3+
title: Build UIs with Laminar
44
---
55

66
In this second tutorial, we learn how to develop UIs in Scala.js with [Laminar](https://laminar.dev/).

doc/tutorial/getting-started/scalablytyped.md renamed to doc/tutorial/scalablytyped.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: doc
3-
title: Getting Started with ScalablyTyped
3+
title: Integrate JavaScript libraries with ScalablyTyped
44
---
55

66
In this third tutorial, we learn how to integrate JavaScript libraries with [ScalablyTyped](https://scalablytyped.org/).

0 commit comments

Comments
 (0)