Documentation ​

This is will show you how to edit our documentation and how to properly contribute while outlining some rules for us.

How to edit ​

All documentation is written in Markdown and is located in the docs folder. You can edit it directly on GitHub or you can clone the repository and edit it locally.

Edits on GitHub will create a Pull Request with the changes and they will be waiting for review.

Once the change is reviewed and approved it will be merged into the branch and will be deployed by our CI/CD pipeline.

Running documentation locally ​

Clone the repository

git clone https://github.com/ddPn08/Radiata.git

Install dependencies

pnpm i

Run the documentation

pnpm docs:dev

You should now be able to access the documentation on http://localhost:5173/Radiata/