Thank you for your decision to contribute to our repo!
To start making changes, let's have an overview about the workflow:
- Fork this repo
- Make changes to your fork
- Submit a PR
- Resolve requested changes to your PR
- Waiting for acceptance from a team member
- Your PR is successfully merged
- The documentation is automatically built and deployed
The PhoMC documentation is built with Docusaurus - an amazing documentation site made by Meta Inc.
The content can be written easily without coding at all, with the support of Markdown.
To have a quick overview of Markdown, read this cheatsheet: https://www.markdownguide.org/cheat-sheet/.
In addition, Docusaurus also supports extra features, which can be viewed here: https://docusaurus.io/docs/markdown-features.
The documentation is divided into categories.
- A category groups relevant pages together.
- We also have
_category_.jsonfile for each category (to describe the name, the position in the sidebar, etc) - Categories can be nested.