From bcdc0648bd7c956f1a898f73be7a392dde44b398 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 24 Jun 2022 12:30:02 +0200 Subject: [PATCH] Contributing: Add instructions on how to run the project --- CONTRIBUTING.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c558806fcb..2351ee86fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,7 +96,28 @@ Follow the procedure below to contribute to the Strapi documentation. git checkout -b ``` - + +7. Run the docs on your computer + + ```bash + cd docs + + # Install dependencies + yarn + + # Run user and developer-docs + yarn dev + + # Run developer-docs only + yarn dev:dev + + # Run user-docs only + yarn dev:user + + ``` + + The project is now up and running at http://localhost:8080 and you should be able to access it in your browser. + You are now ready to contribute to the Strapi documentation! 🚀