From 92b99f82d996949e6b66851f0d2aa50e4eb22b33 Mon Sep 17 00:00:00 2001 From: Gabriel Luiz Freitas Almeida Date: Mon, 31 Jul 2023 14:56:10 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(how-contribute.md):=20updat?= =?UTF-8?q?e=20contribution=20guide=20with=20instructions=20for=20running?= =?UTF-8?q?=20documentation=20locally=20using=20Docusaurus=20=F0=9F=90=9B?= =?UTF-8?q?=20fix(how-contribute.md):=20fix=20formatting=20and=20add=20mis?= =?UTF-8?q?sing=20newline=20at=20end=20of=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/contributing/how-contribute.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/docs/contributing/how-contribute.md b/docs/docs/contributing/how-contribute.md index cdccc271f..53b430496 100644 --- a/docs/docs/contributing/how-contribute.md +++ b/docs/docs/contributing/how-contribute.md @@ -36,10 +36,9 @@ Before you start, make sure you have the following installed: - Poetry (>=1.4) - Node.js -Then install the dependencies and start the development server for the backend: +Then, in the root folder, install the dependencies and start the development server for the backend: ```bash -make install_backend make backend ``` @@ -49,6 +48,7 @@ And the frontend: make frontend ``` + --- ## Docker compose @@ -59,4 +59,19 @@ The following snippet will run the backend and frontend in separate containers. docker compose up --build # or make dev build=1 -``` \ No newline at end of file +``` + +--- + +## Documentation + +The documentation is built using [Docusaurus](https://docusaurus.io/). To run the documentation locally, run the following commands: + +```bash +cd docs +npm install +npm run start +``` + +The documentation will be available at `localhost:3000` and all the files are located in the `docs/docs` folder. +Once you are done with your changes, you can create a Pull Request to the `main` branch.