10. Documentation To-Do List

This file is automatically generated, and contains a list of everything that has been noted as a “To Do” in the documentation.

If you’re looking for a way to help with the Fermentrack documentation, this is a great place to start. You can help by either:

  1. Directly addresing & clearing items from the list below
  2. Adding new items (using the ..todo :: directive) where additional documentation is needed.

Below are the items which need to be addressed:

Todo

Rewrite the Manual Workflow section to document the available options, etc.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/controllers/controller_adding.rst, line 88.)

Todo

Rewrite/fix architecture.rst to match the mkdocs/markdown version

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/develop/architecture.rst, line 4.)

Todo

Write the iSpindel Sensor Setup page

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/gravitysensors/ispindel.rst, line 6.)

Todo

Write the Manual Sensor Setup page

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/gravitysensors/manual.rst, line 6.)

Todo

Figure out how to include the text in about.rst on this page in the HTML version only

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/index.rst, line 55.)

Todo

Add callout for version number here (once the next version of Fermentrack is released)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/installing/install.rst, line 47.)

Todo

Rewrite the Enabling Python to Interact with Bluetooth Section

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/installing/install.rst, line 101.)

Todo

Rewrite the Setting Up Nginx section

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/installing/install.rst, line 121.)

Todo

Finish the Tiltbridge Setup page

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/latest/docs/source/tiltbridge.rst, line 13.)