About this Document

To contribute to this documentation, please visit Github Pitrac

To quickly test your documentation locally, please take the following steps:

  • Become familiar with just-the-docs project just-the-docs

  • Run locally, which is also documented in the above point: bundle exec jekyll serve. Of course I am simplifying as you need to install bundler. You also need to install and configure jekyll

  • View how this project inside docs is configured to get an understanding of the documentation pattern.

  • Finally to deploy. Create your peer-review (PR) request. Github Action workflows will automatically deploy your changes once your PR is merged. This may take about 5-8 minutes to appear. Then simply refresh.