Skip to content

Update creating_component_index.md #3055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
PaulDGAL wants to merge 2 commits into
base: master
Choose a base branch
from
+1 −1
Draft

Update creating_component_index.md #3055

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b24c9ad
Update creating_component_index.md
PaulDGAL Apr 16, 2026
aee5cdf
Merge branch 'master' into patch-3
PaulDGAL Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/creating_component_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This example repository shows custom integrations that live in the `<config_dir>

## The minimum

The scaffold integration contains a bit more than just the bare minimum. The minimum is that you define a `DOMAIN` constant that contains the domain of the integration. The second part is that it needs to define a setup method that returns a boolean if the set-up was successful.
The scaffold integration contains a bit more than just the bare minimum. The minimum is that you define a `DOMAIN` constant (which can consist of alphabetic and the underscore characters, the hyphen is not allowed) that contains the domain of the integration. The second part is that it needs to define a setup method that returns a boolean if the set-up was successful.
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text is outdated as we no longer require a DOMAIN constant at all.

Side note: Details like what characters are allowed in the domain name do not belong in this introductory text. It should be part of the page where we talk about the file structure of an integration.


Create a file `homeassistant/components/hello_state/__init__.py` with one of the two following codeblocks, depending on what you need:

Expand Down