Skip to content

Commit fc833e1

Browse files
committed
Website: fix outdated contributor documentation
1 parent 9606594 commit fc833e1

File tree

4 files changed

+23
-24
lines changed

4 files changed

+23
-24
lines changed

website/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,15 @@ browser.
1616

1717
If you want to work on the demo, see [demo documentation](demo/README.md).
1818

19+
If you want to work on the error documentation, see [errors
20+
documentation](public/errors/README.md).
21+
1922
## Packaging for deployment
2023

21-
Prepare the website for publishing on GitHub pages by running `yarn build`:
24+
Prepare the website for publishing on GitHub pages by first building the [web
25+
demo](demo/README.md) and [quick-lint-js-wasm](../wasm/README.md).
26+
27+
Then, run `yarn build`:
2228

2329
$ cd website # Navigate to this directory.
2430
$ yarn # Install dependencies.

website/demo/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ To build the demo, install the [emscripten SDK][emscripten-sdk] and
99
$ emmake cmake --install build-emscripten --component wasm-demo --prefix public/demo
1010

1111
To run the demo on your own machine, execute the build instructions above, then
12-
run a static file server in the `website` directory:
12+
start the [local development web server](../README.md#Developing):
1313

14-
$ cd website # Navigate to the parent of this directory.
15-
$ python -m http.server 8080
14+
$ cd website
15+
$ yarn
16+
$ yarn start
17+
Server running: http://127.0.0.1:9001/
1618

1719
Then, in your web browser, navigate to the demo page on the server (e.g.
18-
`http://localhost:8080/demo/`).
20+
`http://127.0.0.1:9001/demo/`).
1921

2022
[Ninja]: https://ninja-build.org/
2123
[emscripten-sdk]: https://emscripten.org/docs/getting_started/downloads.html

website/public/cli/README.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

website/public/errors/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# quick-lint-js errors
22

3-
This directory contains documentation on quick-lint-js' warnings and errors.
3+
This directory contains documentation on quick-lint-js' warnings and errors in
4+
HTML form.
45

56
The source documents can be found in [docs/errors/](../../../docs/errors/). This
6-
directory contains HTML generated from those source documents.
7+
directory contains code to convert those source documents into HTML.
78

8-
## Generating
9+
## Setup
910

10-
$ # Build the generator. See docs/BUILDING.md for more details.
11-
$ mkdir build ; cd build ; cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .. ; cd "$OLDPWD"
12-
$ ninja -C build quick-lint-js-generate-error-docs
11+
To show the page, you need to [build
12+
quick-lint-js-wasm](../../../wasm/README.md).
1313

14-
$ # Generate index.html:
15-
$ ./build/docs/quick-lint-js-generate-error-docs \
16-
docs/errors/ website/public/errors/index.template.html website/public/errors/index.html
14+
After building quick-lint-js-wasm, you might need to re-install it with Yarn:
15+
16+
$ cd website
17+
$ yarn install --force

0 commit comments

Comments
 (0)