Skip to content

Create a template for platform/component pages #3572

Closed
@fabaff

Description

@fabaff

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:

  1. How to enable component
  2. Requierements
  3. Configuration Variables
  4. Platform Services
    1. Service A
    2. Service B
    3. Service n
  5. Retrieving the Access Token
  6. Specific information for HASSIO
  7. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    StaleThe PR had no activity for quite some time, and is marked as Stale

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions