Skip to content

Commit f337e46

Browse files
committed
chore: adjust CONTRIBUTING.md to new docs setup
1 parent b763569 commit f337e46

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Please review these guidelines before submitting any pull requests.
1717
* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
1818
* Please remember that we follow [SemVer](http://semver.org/).
1919

20-
## Setup
20+
## 1. Package Development
21+
22+
### Setup
2123

2224
Clone your fork, then install the dev dependencies:
2325
```bash
@@ -30,23 +32,35 @@ Build workbench:
3032
composer build
3133
```
3234

33-
## Playground
35+
### Playground
3436

3537
You can visit a test application via [Workbench](https://github.com/orchestral/workbench):
3638
```bash
3739
composer serve
3840
```
3941

40-
## Lint
42+
### Lint
4143

4244
Lint your code:
4345
```bash
4446
composer lint
4547
```
46-
## Tests
48+
### Tests
4749

4850
Run all tests:
4951
```bash
5052
composer test
5153
```
5254

55+
## 2. Documentation
56+
57+
The documentation is built using [Vitepress](https://vitepress.dev/).
58+
59+
We use [pnpm](https://pnpm.io/) for package management.
60+
61+
To run the site locally, run:
62+
```bash
63+
cd docs
64+
pnpm i
65+
pnpm dev
66+
```

0 commit comments

Comments
 (0)