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:
- Directly addresing & clearing items from the list below
- Adding new items (using the
..todo ::directive) where additional documentation is needed.
Below are the items which need to be addressed:
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/dev/docs/source/controllers/controller_adding.rst, line 88.)
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/dev/docs/source/develop/architecture.rst, line 4.)
Write the iSpindel Sensor Setup page
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/dev/docs/source/gravitysensors/ispindel.rst, line 6.)
Write the Manual Sensor Setup page
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/dev/docs/source/gravitysensors/manual.rst, line 6.)
Write the TiltBridge instructions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/dev/docs/source/gravitysensors/tilt.rst, line 36.)
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/dev/docs/source/index.rst, line 55.)
Come back and re-add the video link once the video of the docker install is available.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/dev/docs/source/installing/install.rst, line 28.)
Finish the Tiltbridge Setup page
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/fermentrack/checkouts/dev/docs/source/tiltbridge.rst, line 19.)