29 Commits

Author SHA1 Message Date
Josef Zweck
57ab2c61a6
Add ConfigEntry.async_on_state_change (#2576) 2025-02-22 12:20:42 +01:00
Erik Montnemery
e8ebc9ff19
Document changed config entry state transitions (#2565)
* Document changed config entry state transitions

* Fix links

* Address review comments

* Address review comments

* Address review comments

* Fix line breaks in lists

* Address review comments

* Bump date

* Close br tags

* Bump date

* Simplify example
2025-02-19 10:01:48 +01:00
Erik Montnemery
1e3a3f154b
Add documentation for config subentries (#2561)
* Add documentation for config subentries

* Address review comments

* component -> integration

* Add blog

* Fix links

* Address review comments

* Add section
2025-02-17 10:02:29 +01:00
J. Nick Koston
b8417d4b07
Add blog post about using async_forward_entry_setups instead of async_forward_entry_setup (#2203)
* Add blog post about ensuring config entries are not unloaded while their platforms are setting up

* adjust existing docs

* Update blog/2024-06-04-ensure_config_entry_platforms_hold_lock.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* newline

* adjust block post for removal of async_late_forward_entry_setup

* adjust block post for removal of async_late_forward_entry_setup

* Update blog/2024-06-04-ensure_config_entry_platforms_hold_lock.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* rename

* Update blog date

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
2024-06-12 21:13:39 -04:00
Tom Brien
f3b9c78185
Update Docusaurus to v3 (#1995) 2024-06-08 10:38:41 +02:00
c0ffeeca7
2a1a921bcd
docs-a-d: apply sentence-style capitalization to headings (#2192)
- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization)
2024-05-23 09:30:17 +02:00
Erik Montnemery
cdcc008469
Document ConfigEntry objects must not be mutated by integrations (#2076)
* Document ConfigEntry objects must not be mutated by integrations

* Update config_entries_config_flow_handler.md

* Update docs/config_entries_config_flow_handler.md
2024-02-11 08:31:16 +01:00
Jan-Philipp Benecke
29cbd4f551
Change add_devices to add_entities (#2041) 2024-01-18 15:36:29 +01:00
Rohan Kapoor
2a47dc07c5
Reference the setup failures documentation as part of the config entry lifecycle documentation (#1890)
* Reference the setup failures documentation as part of the config entry lifecycle documentation

* Add missing period.
2023-08-28 09:29:17 +02:00
Erik Montnemery
1e7124d44a
Add link to config entry migration (#1735) 2023-03-31 15:52:51 +02:00
Franck Nijhof
bbf7781378
Fix GitHub repository links and use dev branch when possible (#971) 2021-06-18 14:08:47 +02:00
Paulus Schoutsen
bc55ccd987
Reorganize architecture section (#839) 2021-03-10 09:17:54 -08:00
Paulus Schoutsen
54b3a80a9a
Update config_entries_index.md 2020-07-17 09:30:30 -07:00
Daniel Shokouhi
2eb402ae8a
Switch example to create_task (#604)
Per https://github.com/home-assistant/core/pull/37741#discussion_r455668639
2020-07-16 21:22:00 +02:00
Franck Nijhof
698139469a
Fix bunch of links (#545) 2020-05-19 09:56:08 +02:00
Franck Nijhof
0145bbbfa7
Move and merge entity documentation (#544) 2020-05-18 14:57:50 +02:00
Franck Nijhof
08884e2cca
Collection of fixes and improvements (#516) 2020-05-11 08:12:01 -07:00
Tom Brien
974b29ebac
Migrate to Docusaurus V2 🐱🐉 (#412)
* Migrate to Docusaurus V2

* Add redirects

Only covers most recent version

* Add omitted scripts folder

* Include working yarn.lock
2020-02-19 19:36:13 +00:00
Ville Skyttä
770185004b
Code block improvements (#382)
* Use f-strings instead of .format()

* Code block language marker fixes

* Make example code blocks syntactically valid Python

* Run all python code blocks through black

https://github.com/scop/misc/blob/master/black_markdown.py

* Add some missing code block language markers

* Use shell language consistently to mark shell code blocks

* Undo folding of some example dicts

* Remove outdated OrderedDict comments per Python 3.7, replace with plain dict
2020-01-13 21:55:41 +02:00
Paulus Schoutsen
ba924f7330
Docs to talk about intregrations (#215)
* Add manifest docs

* Talk about integrations

* Apply suggestions from code review

Co-Authored-By: balloob <paulus@home-assistant.io>

* Address comments

* Apply suggestions from code review

Co-Authored-By: balloob <paulus@home-assistant.io>

* Address comments

* Final comment

* Mention codeowners script
2019-04-06 20:08:49 -07:00
Alan Tse
6d97e4d7df Fix typo in lifecycle (#203)
Signed-off-by: Alan Tse <alandtse@gmail.com>
2019-03-20 13:59:03 +01:00
Paulus Schoutsen
53b1d1669f
Update config_entries_index.md 2019-03-07 10:38:09 -08:00
Paulus Schoutsen
9ad66609ca
Update config_entries_index.md 2019-03-07 10:15:53 -08:00
Paulus Schoutsen
d03e3ddced
Add lifecycle docs (#190) 2019-03-01 17:04:03 -08:00
Robert Svensson
6ab90d72af
Dev docs for config entry options (#185)
* Dev docs for config entry options
2019-02-24 17:51:56 +01:00
Ville Skyttä
3336b07f87 Spelling and grammar fixes 2018-10-29 23:09:38 +02:00
Paulus Schoutsen
421cc24761
Add link to config flow handlers 2018-05-01 09:00:31 -04:00
Marc Khouri
135684a91e suggestions for config entries (#2)
* [WIP] suggestions for config entries

* add working links
2018-04-30 11:47:41 -04:00
Paulus Schoutsen
ddcd75b255 Add basic docs for config entries 2018-04-28 21:28:38 -04:00