Guides
Contribute to the documentation
For a quick fix
If the documentation is missing something, or you found a typo you can quickly edit the documentation:
- Go to the documentation page you want to edit.
- Click on the “Suggest edits” button at the bottom of the page.
- You are redirected to a Github page where you can edit the content of the doc.
- If you did not already have a fork of the repository, you will be prompted to create one.
- Edit the content of the doc.
- Hit “Commit changes…“.
- Click on “Create pull request”.
- Add a title and a description to describe your changes.
- Click on “Create pull request”.
It will be reviewed and merged if approved!
For a bigger modification
If you’d like to add a new page or add a new section to the documentation:
-
Create a new branch:
git checkout -b MY_BRANCH_NAME
-
Run the docs in dev mode
cd apps/docs bun dev
-
All your docs modification will be displayed in real time.
-
Once you are done, commit your changes and push your branch.
-
Create a pull request on the Github repository.
It will be reviewed and merged if approved!