Documentation v1
No due date
25% complete
To broaden SeaPearl's reach, we need to improve the quality of the documentation available. This means:
- having blog posts explaining the underlying theory
- having clear, up-to-date, easy to follow tutorials that work without hassle. The tutorials can be accompanied by more documentation if needed
- having an up-to-date, detailed formal documentation for the…
To broaden SeaPearl's reach, we need to improve the quality of the documentation available. This means:
- having blog posts explaining the underlying theory
- having clear, up-to-date, easy to follow tutorials that work without hassle. The tutorials can be accompanied by more documentation if needed
- having an up-to-date, detailed formal documentation for the code
- having the resources that new contributors will need to get them up to speed: a contributor's guide, a project setup guide, internal documentation, issue tracking, standard practices, etc.