search

palazzem / econnect-python

API adapter used to control programmatically an Elmo alarm system
BSD 3-Clause "New" or "Revised" License
8 stars 5 forks source link

Missing documentation #41

Closed palazzem closed 10 months ago

palazzem commented 4 years ago

Overview

The README shows the most important things about the project but probably we should release a more complete version on https://readthedocs.org/

palazzem commented 1 year ago

Repurposing this issue to actually write a proper documentation. We should catch all possible issues and suggest users to go to a troubleshooting page where we explain design decisions and/or how to enable the debug mode. This makes simpler bug reporting and removes 1-2 steps of the triaging phase.

We don't need to move anything to readthedocs as we can keep everything in the README.

Action items:

  1. Write a README that describes the actual correct usage
  2. Add a troubleshooting page that explains how to triage errors
  3. Create a custom Exception that in case of error logs the troubleshooting page link
  4. Use the custom Exception where there are errors
palazzem commented 10 months ago

Documentation is good enough. Closing.