Skip to content

Commit 25a443e

Browse files
Update webpack script for sbt task
1 parent 33ae504 commit 25a443e

File tree

5 files changed

+10
-355
lines changed

5 files changed

+10
-355
lines changed

scala3doc/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,13 @@ the documentation won't work completely if you don't.
4242

4343
Make sure you have installed `node`
4444

45-
- Go to `resources` folder and run: `npm i`
46-
- Start development server and weback in watch mode: `npm run dev`
47-
- Finally, run `sbt scala3/generateTestcasesDocumentation` when you want to preview newest changes
45+
Frontend resources should be built automatically after running any `sbt` task that uses
46+
`generateDocumentation`, such as `sbt scala3/generateTestcasesDocumentation`
47+
48+
You can also do it manually by running `npm i` and `npm run build`in the `resources` folder.
49+
To see the changes you still need to copy sources to `output` folder, this is normally done automatically by the `sbt` task.
50+
51+
You might want to turn on sourcemaps for local development.
4852

4953
## CLI Documentation
5054

scala3doc/e2e/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
### Running tests locally
99

1010
- generate the test docs: `sbt scala3doc/generateTestcasesDocumentation`
11-
- run the web server in the `npm run serve`
11+
- run the web server: `npm run serve`
1212
- run `npm run cypress:open` to see the cypress UI or `npm run cypress:run` to run tests headlessly

0 commit comments

Comments
 (0)