Skip to content

Commit f23ea08

Browse files
committed
update readme
1 parent 316f257 commit f23ea08

File tree

2 files changed

+3
-30
lines changed

2 files changed

+3
-30
lines changed

README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,38 +23,10 @@ This is the official documentation platform for the [ReScript](https://rescript-
2323
# For first time clone / build (install dependencies)
2424
yarn
2525

26-
# Initial build
27-
yarn rescript
28-
29-
# Build the index data. Only needed for initial clone (or content H2 changes)
30-
yarn update-index
31-
32-
# In a new tab
26+
# Run ReScript, Vite, and Wrangler in development mode
3327
yarn dev
34-
35-
open localhost:3000
36-
```
37-
38-
In case you want to run ReScript in watchmode:
39-
40-
```sh
41-
yarn rescript -w
4228
```
4329

44-
## Build Index Data
45-
46-
We are parsing our content for specific index data (such as, all interesting
47-
search terms we need for searching inside the `Belt` docs). You can create your
48-
index by running following command:
49-
50-
```sh
51-
yarn update-index
52-
```
53-
54-
All the index data is stored in `index_data`, but will not be tracked by git.
55-
Make sure to build the index after a fresh clone, otherwise Next might not
56-
build specific pages (file `index_data/x.json` not found).
57-
5830
## Project Structure Overview
5931

6032
- `data`: Contains hand-curated data, such as sidebar ordering, blog data, etc

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@
2323
"dev:res": "rescript watch",
2424
"dev:vite": "react-router dev --host",
2525
"dev:wrangler": "yarn wrangler pages dev build/client",
26-
"dev": "yarn dev:res & yarn dev:vite & yarn dev:wrangler",
26+
"dev": "yarn prepare && yarn dev:res & yarn dev:vite & yarn dev:wrangler",
2727
"format": "prettier . --write --experimental-cli && rescript format",
28+
"prepare": "yarn build:res && yarn build:scripts && yarn build:update-index",
2829
"preview": "yarn build && static-server build/client",
2930
"reanalyze": "rescript-tools reanalyze -all-cmt .",
3031
"test": "node scripts/test-examples.mjs && node scripts/test-hrefs.mjs"

0 commit comments

Comments
 (0)