Skip to content

Commit 82fd926

Browse files
author
Erik Soehnel
committed
update readme for new docs app
1 parent b307401 commit 82fd926

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,18 @@ const res = isMyDataValid(data)
124124
* `npm run test` - run build process and tests for all modules
125125
* `npm run test:build` - run build process for all modules
126126

127-
#### Docs
127+
#### Benchmark Viewer
128128

129-
* `npm run docs:serve` - result viewer
130-
* `npm run docs:build` - build docs
131-
* `npm run docs:watch` - watch docs for changes and rebuild
129+
A basic preact+vite app lives in [`/docs`](/tree/master/docs).
130+
It is deployed via github pages whenever something has been pushed to the main branch.
131+
132+
```sh
133+
cd docs
134+
135+
npm run dev # develop
136+
npm run build # build
137+
npm run preview # preview the build
138+
```
132139

133140
#### Linting
134141

@@ -163,18 +170,18 @@ const res = isMyDataValid(data)
163170
### Node.js runtime
164171

165172
* update Node.js version matrix in `.github/workflows/pr.yml` and `.github/workflows/release.yml`
166-
* update `NODE_VERSIONS` in `docs/dist/app.tsx` and run `npm run docs:build`
173+
* update `NODE_VERSIONS` in `docs/src/App.tsx`
167174
* optionally set `NODE_VERSION_FOR_PREVIEW` in `benchmarks/helpers/main.ts`
168175

169176
### Bun runtime
170177

171178
* update bun version matrix in `.github/workflows/pr.yml` and `.github/workflows/release.yml`
172-
* update `BUN_VERSIONS` in `docs/dist/app.tsx` and run `npm run docs:build`
179+
* update `BUN_VERSIONS` in `docs/src/App.tsx`
173180

174181
### Deno runtime
175182

176183
* update Deno version matrix in `.github/workflows/pr.yml` and `.github/workflows/release.yml`
177-
* update `DENO_VERSIONS` in `docs/dist/app.tsx` and run `npm run docs:build`
184+
* update `DENO_VERSIONS` in `docs/src/App.tsx`
178185

179186
## Test cases
180187

0 commit comments

Comments
 (0)