|
|
|
You can write documentation for your project as a wiki.
|
|
|
|
Members of your team that have access to the project can also make amendments here.
|
|
|
|
|
|
|
|
You can have all the normal markdown objects like titles, links etc. If you add a link to a (local) page that doesn't exist then it will create a link to help you go and create that page.
|
|
|
|
|
|
|
|
The wiki supports even more amazing goodies though. You can refer to parts of you project, like commits (just type in the commit id) , issues (using `#`) or other pavlovia users (using `@`).
|
|
|
|
|
|
|
|
You can even use [mermaid](https://mermaidjs.github.io/) to add charts like flow diagrams and Gantt charts. Checkout the code for this:
|
|
|
|
|
|
|
|
```mermaid
|
|
|
|
gantt
|
|
|
|
title Study plans
|
|
|
|
dateFormat YYYY-MM-DD
|
|
|
|
section Study 1
|
|
|
|
Pilot :a1, 2018-01-01, 10d
|
|
|
|
Main participants :after a1 , 40d
|
|
|
|
section Study 2
|
|
|
|
Check modelling code :2018-01-12 , 12d
|
|
|
|
Forward modelling of results : 24d
|
|
|
|
``` |
|
|
\ No newline at end of file |
