Commit Graph

82 Commits

Author SHA1 Message Date
G Johansson
bec2b74a07 Docs for SchemaConfigFlowHandler (#2801)
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
2025-10-13 15:53:08 +02:00
Martin Hjelmare
b4b9676ed7 Document config flow next_flow parameter (#2792) 2025-09-11 16:58:55 +03:00
Andrew Jackson
bc2542a7a5 Correction to Config Flow Subentry reconfigure documentation (#2741) 2025-08-02 21:19:02 +02:00
Joost Lekkerkerker
6316754bd2 Use partner email address for account linking (#2639) 2025-04-09 17:07:47 +01:00
Jeef
40de1f8525 Update config_entries_config_flow_handler.md (#2279)
Matching what you get from scaffolding
2025-03-01 23:18:18 +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
Joost Lekkerkerker
cf52c30bc0 Add integration quality scale docs (#2457)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
2024-11-20 17:41:19 +01:00
IceBotYT
6d6ec9d734 Fix dead link on config flow page (#2305) 2024-10-26 16:26:49 +02:00
epenet
0e20b58399 Blog post for new helpers in reauth and reconfigure flows (#2356)
* New helpers and best practises for reauth and reconfigure flows

* Update and rename 2024-10-08-reauth-reconfigure-helpers.md to 2024-10-17-reauth-reconfigure-helpers.md

* Update config_entries_config_flow_handler.md

* Update config_entries_config_flow_handler.md

* Rename 2024-10-17-reauth-reconfigure-helpers.md to 2024-10-21-reauth-reconfigure-helpers.md

* Update 2024-10-21-reauth-reconfigure-helpers.md

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2024-10-21 14:23:08 +02:00
epenet
0faaf12ed5 Adjust reauth/reconfigure documentation to highlight expected result (#2352)
* Adjust reauth/reconfigure documentation to highlight expected result

* Update config_entries_config_flow_handler.md

* Update config_entries_config_flow_handler.md
2024-10-08 22:26:47 +02:00
epenet
c99a54ff6c Document _abort_if_unique_id_mismatch helper (#2353)
* Document _abort_if_unique_id_mismatch helper

* Update docs/config_entries_config_flow_handler.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Update docs/config_entries_config_flow_handler.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2024-10-08 10:18:19 +02:00
epenet
4332309a44 Document get_reauth_entry and get_reconfigure_entry helpers (#2347) 2024-10-03 22:40:51 +02:00
epenet
a7d0840abc Revert "Adjust async_step_reconfigure documentation (#2345)" (#2351)
This reverts commit b86ac6c3f1.
2024-10-03 14:44:12 +02:00
Erik Montnemery
a20c3d26c6 Document async_has_matching_flow (#2340)
* Document async_has_matching_flow

* Update docs/config_entries_config_flow_handler.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Accept suggestion from the bot

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2024-10-03 13:01:14 +02:00
epenet
7256c34950 Adjust async_step_reauth documentation (#2346)
* Adjust async_step_reauth documentation

* Update config_entries_config_flow_handler.md
2024-10-02 01:51:14 +02:00
epenet
b86ac6c3f1 Adjust async_step_reconfigure documentation (#2345)
* Adjust async_step_reconfigure documentation

* Update config_entries_config_flow_handler.md
2024-10-02 01:50:09 +02:00
Erik Montnemery
2ed21df18a Document how config flow title is determined (#2343)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-09-30 18:53:16 +02:00
Erik Montnemery
2e9342582f Add link to core translation doc from config flow doc (#2342) 2024-09-30 14:49:50 +02:00
Erik Montnemery
50c6bfa257 Clarify unique ID checks in config flows (#2339)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2024-09-27 14:43:38 +02:00
Erik Montnemery
82f1ccda95 Remove documentation of unignore flow (#2337) 2024-09-25 20:29:39 +02:00
rrooggiieerr
1d2df8b0e7 Fix indentation (#2239) 2024-07-05 20:45:15 +02:00
Teemu R
e49e2b7fbf Document reauth and import as reserved config flow steps (#1686) 2024-06-10 21:22:55 +02:00
Rod Payne
fd49ba3e01 Fix syntax in config_entries_config_flow_handler.md example (#2197) 2024-05-29 08:31:49 +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
Tony Brobston
0177ff3741 qualily -> quality, fix typo (#2162) 2024-05-01 23:33:17 +02:00
Jan Bouwhuis
717de66a3f Always reload after successful reauthentication (#2154) 2024-04-24 15:27:54 +02:00
G Johansson
d2b2e8751e Reconfigure step (#2099)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
Co-authored-by: Erik Montnemery <erik@montnemery.com>
2024-03-22 12:43:19 +01:00
Jan-Philipp Benecke
47042ac3de Use update, reload and abort helper in reauth documentation (#2083) 2024-02-19 00:24:48 +01: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
Erik Montnemery
4603892c50 Document config entry unique ID must be a string (#2075) 2024-02-09 02:10:19 +01:00
Erik Montnemery
b6feca5fdb Document config entry minor version (#2017)
* Document config entry minor version

* Update docs/config_entries_config_flow_handler.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-12-19 00:20:02 +01:00
G Johansson
a350b7d818 change logger to debug for config entry migration (#1901) 2023-09-07 20:20:59 +02:00
Erik Montnemery
df7092023c Clarify documentation of async_migrate_entry (#1734) 2023-03-31 15:52:22 +02:00
MinchinWeb
ca87a8fb18 Update config_entries_config_flow_handler.md (#1713)
Fix Markdown link
2023-03-14 15:37:14 +01:00
Teemu R
40559d2405 Clarify config flow step definitions (#1683)
* Clarify config flow step definitions

* Update docs/config_entries_config_flow_handler.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-02-16 23:40:24 +01:00
rrooggiieerr
bde1a15808 Add schema version to example config flow (#1623) 2023-01-16 08:50:00 +01:00
Sven Serlier
9455a2eaf5 Update two URLs to avoid redirect (#1626)
* Update oauth URL

* Update python zeroconf URL
2023-01-13 08:15:49 +01:00
Paulus Schoutsen
30b68f244e Voice (#1620)
* Migrate voice content

* Handle duplicate intent pages

* ABC package.json

* Fix some links

* Fix more links

* Update path

* Update docs/voice/overview.md
2023-01-10 08:38:17 -05:00
Paulus Schoutsen
0c8a7b6048 Modernize sidebar menu and consolidate content (#1619)
* Modernize sidebar menu

* Move more architecture things over

* Move APIs to their application docs

* Clean up some titles and de-duplicate

* Consolidate repair platform and issue registry

* More moving

* Address comments

* Move API down
2023-01-09 13:44:44 -05:00
Didier C
d8e0e6b026 Add a mising closing curly brace (#1588)
in *Unique IDs* section, the `strings.json` example require one more closing curly brace to be valid json
2022-12-15 16:58:37 +02:00
Franck Nijhof
500457acd9 Not to Tox (#1542) 2022-11-23 14:40:48 +01:00
Allen Porter
23fa78ae52 Update OAuth reauth with simpler example (#1483) 2022-10-02 08:13:17 +02:00
J. Nick Koston
df74364b2f Document bluetooth discovery (#1389)
* Document bluetooth discovery

* fixes

* Update creating_integration_manifest.md

* Update docs/network_discovery.md

* Update docs/network_discovery.md

* Update docs/network_discovery.md

* Update network_discovery.md

* Update creating_integration_manifest.md

* adjust types
2022-07-09 11:21:17 +02:00
Allen Porter
416b087326 Merge pull request #1279 from allenporter/developer_credentials
Documentation for Application Credentials platform initial features
2022-04-30 09:48:32 -07:00
Allen Porter
8fc9d847b5 Update documentation for developer credentials after PR discussion feedback 2022-04-16 11:49:02 -07:00
kongo09
1f6624ffd8 Abort config flow for already_configured (#1280)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-04-04 11:40:19 +02:00
Allen Porter
92b171187e Update ConfigEntry migration to follow current best practices (#1123) 2021-11-04 07:43:27 +01:00
epenet
e929379d7f Fix typo (#1052) 2021-09-06 08:04:57 +02:00
epenet
6f0519ba66 Recommend ConfigEntryAuthFailed for reauthentication (#1048)
* raise ConfigEntryAuthFailed

* Update config_entries_config_flow_handler.md
2021-09-02 21:23:55 +02:00
J. Nick Koston
2be68d6893 Document USB discovery (#1031) 2021-08-21 15:38:47 -05:00