Season of Docs 2021 Information

Welcome to the ideas page for the PyMC3 entry in the 2021 Season of Docs. This page aggregates information regarding PyMC3's proposal, to give candidate writers an idea of what we are looking for to improve our project's documentation this year.

Ideas

Documentation Site Redesign/Restructure

• navigation sidebar
• move documentation out of Uncyclo
• separation of library docs and project docs:
  • library: about the software itself; tutorials, reference materials, etc.
  • project: governance, community, etc.

Architecture Documentation

Most documentation includes an API reference as the only insight

• walk-through of computational backend
• important given the significant changes to PyMC3 computational backend
• developer-orientated

Introductory Course Materials for New Users

• most of our software documentation exists as ad hoc tutorials and howtos in the form of isolated Jupyter notebooks.
• no "syllabus" for new user to learn about how to use PyMC in a stepwise fashion

Reference

• https://documentation.divio.com/

Contact Us

The best way to contact the PyMC3 development team is via the project Discourse site.