Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.11 KB

File metadata and controls

27 lines (22 loc) · 1.11 KB

Contributing Guide

Thank you for your decision to contribute to our repo!

Workflow

To start making changes, let's have an overview about the workflow:

  1. Fork this repo
  2. Make changes to your fork
  3. Submit a PR
  4. Resolve requested changes to your PR
  5. Waiting for acceptance from a team member
  6. Your PR is successfully merged
  7. The documentation is automatically built and deployed

Internals

Content format

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.

Organization

The documentation is divided into categories.

  • A category groups relevant pages together.
  • We also have _category_.json file for each category (to describe the name, the position in the sidebar, etc)
  • Categories can be nested.