Closed
Description
As suggested by @ajfriesen.
How about having a template for the different parts of documentation?
At least for the components, I could imagine that.Just define some headings which most components share like:
- How to enable component
- Requierements
- Configuration Variables
- Platform Services
- Service A
- Service B
- Service n
- Retrieving the Access Token
- Specific information for HASSIO
- Examples
In the different sections we could write down some rules from your list or some best practice approaches. (If you start a new component, this could help.)
If a section is empty everybody knows there is help needed. If the section should be empty we could mark it as not necessary.This is just a quick example and needs some work, but I think you get the idea.