diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13aea9e..4c16ea5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,12 +60,22 @@ npm i npm start ``` -5. Open the demo application on you browser. Browse to the address: +5. Open the demo application on you browser. Browse to the address ``` https://localhost:3000 ``` + +# The Documentation website + + +Want to update the documentation? We also maintain the documentation website in this repository. The source for this is found in the `docs` directory. You can also start the dev server for the docs website with the following command: + +``` +npm run docs +``` + # Running the linter and tests Please run the linter and tests before creating a PR to avoid delays in PR reviews. Fix all linting errors or failing tests whey you run the following commands. diff --git a/package.json b/package.json index 0c6c325..0945b7f 100644 --- a/package.json +++ b/package.json @@ -21,6 +21,7 @@ "build": "npm run build --workspaces --if-present", "test:watch": "npm run test:watch --workspaces --if-present", "dev": "npm run dev -w demo", + "docs": "npm run dev -w docs", "bump": "npm version patch -w", "bump-minor": "npm version minor -w", "bump-major": "npm version major -w",