From 8c7f8eda9f29c689ca65612c6450b3606a44e93f Mon Sep 17 00:00:00 2001 From: Dan Bjorge Date: Tue, 28 Jun 2022 19:24:28 -0400 Subject: [PATCH] docs(contributing): add instructions for testing doc changes (#15205) --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 962740503d..9e4b58fa5c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,6 +114,12 @@ To run the documentation linter, use: npm run doc ``` +To build the documentation site locally and test how your changes will look in practice: + +1. Clone the [microsoft/playwright.dev](https://github.com/microsoft/playwright.dev) repo +1. Follow [the playwright.dev README instructions to "roll docs"](https://github.com/microsoft/playwright.dev/#roll-docs) against your local `playwright` repo with your changes in progress +1. Follow [the playwright.dev README instructions to "run dev server"](https://github.com/microsoft/playwright.dev/#run-dev-server) to view your changes + ### Adding New Dependencies For all dependencies (both installation and development):