Skip to content

Commit 8c6d4be

Browse files
bteabluwy
andauthored
chore: update CONTRIBUTING.md (#16465)
Co-authored-by: Bjorn Lu <[email protected]>
1 parent 2322657 commit 8c6d4be

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ To make this file used by `git blame`, you need to run the following command.
3131
git config --local blame.ignoreRevsFile .git-blame-ignore-revs
3232
```
3333

34+
## Documentation
35+
36+
To develop the `docs/` site:
37+
38+
1. Run `pnpm run build` in Vite's root folder. This will generate the types for `twoslash` to work in the code examples. If the types are not available, errors will be logged in step 2 but does not prevent the site from working.
39+
40+
2. Run `pnpm run docs` in Vite's root folder.
41+
3442
## Debugging
3543

3644
To use breakpoints and explore code execution, you can use the ["Run and Debug"](https://code.visualstudio.com/docs/editor/debugging) feature from VS Code.
@@ -166,7 +174,7 @@ For a mock dependency, make sure you add a `@vitejs/test-` prefix to the package
166174

167175
## Debug Logging
168176

169-
You can set the `DEBUG` environment variable to turn on debugging logs (e.g. `DEBUG="vite:resolve"`). To see all debug logs, you can set `DEBUG="vite:*"`, but be warned that it will be quite noisy. You can run `grep -r "createDebugger('vite:" packages/vite/src/` to see a list of available debug scopes.
177+
You can set the `--debug` option to turn on debugging logs (e.g. `vite --debug resolve`). To see all debug logs, you can set `vite --debug *`, but be warned that it will be quite noisy. You can run `grep -r "createDebugger('vite:" packages/vite/src/` to see a list of available debug scopes.
170178

171179
## Pull Request Guidelines
172180

0 commit comments

Comments
 (0)