Skip to content

"How-To" needs to be a link on all the pages that describe how things work. #37148

Open
@MarkusBiggus

Description

@MarkusBiggus

Feedback

This page has a heading notice that says these Options are being phased out.
What it doesn't say is what to do instead of using these Options.
Similar issue with all the pages that explain how things work, they don't provide a link to docs that explain How-To use the things being explained.

It leads to quite frustrating searches for something you don't actually know what you're looking for. This is further exacerbated by finding explanations of How-To that are no longer valid in current version of hass.
One can waste considerable time searching for, and possibly following, incorrect instructions that were once correct.

A reference example of best practice to create a custom component with all features implemented (something that can be run in dev Core) would be a terrific help. Some users have provided templates and guides, but these tend to be of of date or incomplete.

Some examples, like multi-step config flow, simply uses wait() function as the step, it is such a trivial example it is not useful to actually implement a multi-step config flow. (I'm sure it makes sense to an expert, not helpful to a novice who relies on these docs for guidance). A proper example that works, shows forms and collects data would be many times more helpful and save many hours of trial-and-error trying to guess how it must be implemented.

URL

https://www.home-assistant.io/docs/configuration/platform_options/

Version

2025.1.4

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions