38 Commits

Author SHA1 Message Date
Petar Petrov
7c85921b92
Document new async_update_progress flow method (#2643) 2025-04-14 15:30:43 +02:00
Thomas D
da9aede0c9
Update data_entry_flow_index.md (#2525)
Use Marker for schema dictionary keys (https://github.com/home-assistant/frontend/issues/22419#issuecomment-2425612852)
2025-01-11 17:49:13 +00:00
Erik Montnemery
e93d47c363
Document icon for data entry sections (#2292)
* Document icon for data entry sections

* Try to find reason for build error

* Update data_entry_flow_index.md

* tiny tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
2024-08-27 17:20:18 +02:00
Erik Montnemery
a4fff7c05d
Improve documentation of collapsible sections in data entry flows (#2288) 2024-08-27 15:39:03 +02:00
Erik Montnemery
d87b9e2d90
Add link to core translation doc from data entry flow doc (#2287) 2024-08-27 15:05:30 +02:00
Erik Montnemery
b47e610989
Document collapsible sections in data entry forms (#2233) 2024-06-25 13:01:42 +02: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
5311ee458d
Update data_entry_flow_index.md (#2040) 2024-01-13 02:41:46 +01:00
Erik Montnemery
472e148b95
Update documentation for FlowHandler.async_show_progress (#2037)
* Update documentation for FlowHandler.async_show_progress

* Fix typo

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2024-01-11 16:48:51 +01:00
Joost Lekkerkerker
48b7f70208
Explain difference between options and data in the config flow (#1934)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2023-09-27 20:31:26 +02:00
Alex Wijnholds
a25fc6a6d0
Explain async_remove in the Config Flow (#1792)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-06-27 21:19:06 +02: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
epenet
967c787b35
Document add_suggested_values_to_schema (#1541) 2022-11-30 08:23:37 +01:00
Steve Repsher
e95eef1f04
Add Autofill to data entry flow (#1528)
Co-authored-by: J. Nick Koston <nick@koston.org>
2022-11-15 12:59:11 -06:00
epenet
f8275c2bd7
Add FlowResultType enum to data entry flow (#1357) 2022-06-07 17:42:31 -07:00
Paulus Schoutsen
7aeb2a00ec
Add blog about some new features (#1258)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-03-30 17:17:31 -07:00
Paulus Schoutsen
54a837d5bc
Document show_menu data entry flow (#1247)
* Document show_menu data entry flow

* Update docs/data_entry_flow_index.md

Co-authored-by: Allen Porter <allen@thebends.org>

* Update docs/data_entry_flow_index.md

Co-authored-by: Allen Porter <allen@thebends.org>
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2022-03-24 07:47:17 +01:00
Lukas Kempf
76ba74ab87
Fix syntax error in example code (#1040) 2021-08-26 13:03:20 +02:00
Marc Mueller
f89e7153e2
Remove pylint unused-import (#871) 2021-03-30 08:32:38 +02:00
Philip Allgaier
8919af1601
Added link to backend translation page (#858) 2021-03-22 12:01:55 +01:00
Paulus Schoutsen
bc55ccd987
Reorganize architecture section (#839) 2021-03-10 09:17:54 -08:00
Martin Hjelmare
0e2ebe957e
Improve data entry flow show progress docs (#725) 2020-11-17 12:33:50 +01:00
Martin Hjelmare
3ee99ae0f8
Document data entry flow show progress (#717)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2020-11-09 18:48:49 +01:00
Aidan Timson
c89143933c
Fix typo (#571) 2020-06-07 10:44:06 +01:00
Franck Nijhof
08884e2cca
Collection of fixes and improvements (#516) 2020-05-11 08:12:01 -07:00
On Freund
f0973bf4d7
Update Data Entry Flow docs with field pre-fill (#492)
Update the docs with instructions on pre-filling values using either `default` or `suggested_value`, and the differences between them.
2020-05-03 09:26:22 -04:00
Paulus Schoutsen
9dce45bf85
Document advanced mode for flows (#473)
Co-Authored-By: Franck Nijhof <git@frenck.dev>
2020-04-24 11:11:01 -07:00
Austin Mroczek
9b8a18d1b2
Update data_entry_flow_index.md (#408)
It seems the code has moved to async_create_entry() but the docs have not.

Changes all listings of create_entry() to async_create_entry()
2020-02-17 08:33:53 -08: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
Dave T
71799579e5 Grammar/typo corrections in dev docs (#379)
* Improve grammar

* Improve grammar

* Improve grammar

* Improve grammar
2020-01-04 16:00:17 +01:00
Paulus Schoutsen
e650f89dd1
Add external step UX tip 2019-10-15 16:38:31 -07:00
Paulus Schoutsen
ae62362b7d
Update config entry docs (#273) 2019-06-12 09:31:05 -07:00
Fabian Affolter
9ad43a40cb
Minor changes (#77) 2018-08-21 22:04:31 +02:00
Jason Hu
10af454c21 Allow finish flow callback change result type (#76) 2018-08-21 21:38:48 +02:00
Jason Hu
53fef528b8 Update data entry flow doc to match current design (#75) 2018-08-21 15:35:03 +02:00
Paulus Schoutsen
6d6783cd22 data entry now called introduction in sidebar 2018-04-28 21:50:47 -04:00
Paulus Schoutsen
ddcd75b255 Add basic docs for config entries 2018-04-28 21:28:38 -04:00