📝 docs(how-contribute.md): update contribution guide with instructions for running documentation locally using Docusaurus

🐛 fix(how-contribute.md): fix formatting and add missing newline at end of file
This commit is contained in:
Gabriel Luiz Freitas Almeida 2023-07-31 14:56:10 -03:00
commit 92b99f82d9

View file

@ -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
```
```
---
## 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.