mirror of
https://github.com/Brotocol-xyz/bro-sdk.git
synced 2026-01-12 14:54:21 +08:00
chore: add dev instructions for docs
This commit is contained in:
18
docs/dev-instructions.md
Normal file
18
docs/dev-instructions.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Test Instructions
|
||||
|
||||
## Visualize Typedoc Documentation
|
||||
|
||||
In the root directory, run:
|
||||
|
||||
```bash
|
||||
pnpm run docs:watch
|
||||
```
|
||||
|
||||
In a new terminal window, run:
|
||||
|
||||
```bash
|
||||
cd generated/docs
|
||||
python -m http.server 8080
|
||||
```
|
||||
|
||||
Open `http://localhost:8080` in your browser to view the documentation.
|
||||
Reference in New Issue
Block a user