Documentation

The formal documentation is distributed through at our ReadTheDocs site. All of the documentation is written in Markdown.

Commits

Documentation must always be included in the same commit to reference the updated functionality.

Documentation Directory

The documentation is held under the /.docs directory in addition to the README.md file. The docs directory includes the whole package or User Gudei that is presented from RTD. The README file is just a repo summary of important basic information for the project. You can review documentation at any point in time by reviewing the commit and the /.docs directory.

Formal Releases

Tagged stable releases will trigger an RTD workflow that updates the documentation on ReadTheDocs. This means that documentation there is 100% aligned to what exists in the latest specific release.

Writing Docs Locally

You can leverage mkdocs to get a representation of the working draft of your documentation locally. Check the mkdocs page for instructions on getting it running. Verify the formatting is as expected and categorization is presented as expected.