From 301f52395689abce0a7a1c3b0f3e70a81e2c8e41 Mon Sep 17 00:00:00 2001 From: TASNEEM KOUSHAR Date: Wed, 1 Sep 2021 14:00:37 +0530 Subject: [PATCH] docs: add website details to contributing.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0c503d7..a4017838 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,7 @@ * [Commit Messages](#commit-messages) * [Writing Documentation](#writing-documentation) * [Writing TSDoc Comments](#writing-tsdoc-comments) + * [Running New Documentation website locally](#running-new-documentation-website-locally) * [Adding New Dependencies](#adding-new-dependencies) * [Running & Writing Tests](#running--writing-tests) * [Public API Coverage](#public-api-coverage) @@ -179,6 +180,15 @@ Each change to Puppeteer should be thoroughly documented using TSDoc comments. R - Every new method needs to have either `@public` or `@internal` added as a tag depending on if it is part of the public API. - Keep each line in a comment to no more than 90 characters (ESLint will warn you if you go over this). If you're a VSCode user the [Rewrap plugin](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap) is highly recommended! + +## Running New Documentation website locally + +- In the Puppeteer's folder, install all dependencies with `npm i`. +- run `npm run generate-docs` which will generate all the `.md` files on `puppeteer/website/docs`. +- run `npm i` on `puppeteer/website`. +- run `npm start` on `puppeteer/website`. + + ## Adding New Dependencies For all dependencies (both installation and development):