File tree Expand file tree Collapse file tree 1 file changed +18
-4
lines changed Expand file tree Collapse file tree 1 file changed +18
-4
lines changed Original file line number Diff line number Diff 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
2224Clone your fork, then install the dev dependencies:
2325``` bash
@@ -30,23 +32,35 @@ Build workbench:
3032composer build
3133```
3234
33- ## Playground
35+ ### Playground
3436
3537You can visit a test application via [ Workbench] ( https://github.com/orchestral/workbench ) :
3638``` bash
3739composer serve
3840```
3941
40- ## Lint
42+ ### Lint
4143
4244Lint your code:
4345``` bash
4446composer lint
4547```
46- ## Tests
48+ ### Tests
4749
4850Run all tests:
4951``` bash
5052composer 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+ ```
You can’t perform that action at this time.
0 commit comments