Commit Graph

76 Commits

Author SHA1 Message Date
Abílio Costa
f10dd7d9d4 Add new trigger implementation docs (#2823) 2025-10-20 13:24:34 +02:00
Jan Čermák
cb8bec6e1e Migrate HAOS docs from the OS repo (#2748) 2025-09-29 16:34:20 +02:00
Michael
b101c9d6bd Add generic guide to setup devcontainer environment (#2227)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-09-12 20:33:10 +02:00
Timothy
26070fb788 Add android strict mode documentation (#2719) 2025-07-09 10:07:50 +02:00
c0ffeeca7
b39b7da6f9 Move general style guide to its own page (#2647) 2025-04-22 20:10:30 +02:00
J. Nick Koston
87162ada68 Add additional docs for importing code with asyncio (#2338)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
2025-04-16 22:52:32 +02:00
Timothy
36ddedd3df Add android developer playground tip (#2642) 2025-04-10 12:43:22 +02:00
Timothy
74f8978d63 Add release build information (#2638)
* Add instruction for release build

* Add missing links to the Google Play Store

* Update release.md
2025-04-09 12:59:10 -07:00
Timothy
792895f2cc Remove translation link from android section (#2637) 2025-04-09 15:41:02 +02:00
Timothy
b73ee9122d Add Android documentation (#2626) 2025-04-09 12:19:24 +02:00
Abílio Costa
48584340de Move IQS rules into its own page (#2608) 2025-03-31 14:14:40 +02:00
c0ffeeca7
8589e39d33 Add documentation about creating integration documentation (#2541)
* Add documentation about creating integration documentation

- showcases some documentation features such as glossary entries, My links, collapsible text, and reuse elements
- shows the documentation structure
- shows the example text from the integration quality scale

* Add section on reuse

* code fence to fix build error

* Remove links that no longer work after code fencing the rest of the text

* Rephrase

* Code fence elements to fix build

* Fix link

* Video: improve intro para

* Fix links

* Fix more links..

* Improve structure

- example text: add titles
- configuration section: add screenshots

* Structure list: add link to example text sections

* Attempt to fix build

* Attempt to fix build

* Fix list

* Fix header

* Revert heading level change

* remove example text and refer to template instead

* Update intro

* Update docs/documenting/lorem-ipsum.md

* Rename file name from lorem-ipsum to integration-docs-examples
2025-02-20 22:11:34 +01:00
Abílio Costa
3afcff2985 Add integration system health documentation page (#2549)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2025-02-05 16:40:09 +00:00
Abílio Costa
e34755845c Add page for config entry diagnostics (#2469)
* Add page for config entry diagnostics

* Address review suggestions

* Revert sidebar

* Move page out of config entries and address suggestions

* Update docs/core/integration_diagnostics.md

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

* Reword warning

* Remove device ids from sensitive list; link cleanup

* Clarify diag download methods

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-11-27 14:21:46 +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
Paul Bottein
a34195da26 Update custom cards, add custom badges and custom card features (#2258)
* Add custom card feature doc

* Add layout options in custom card documentation

* Update example

* Add custom badge documentation

* Update docs/frontend/custom-ui/custom-card.md

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

* Update docs/frontend/custom-ui/custom-card.md

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

* Update docs/frontend/custom-ui/custom-card-feature.md

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

* Update docs/frontend/custom-ui/custom-card.md

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

* Update docs/frontend/custom-ui/custom-badge.md

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

* Update docs/frontend/custom-ui/custom-badge.md

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

* Update docs/frontend/custom-ui/custom-badge.md

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

* Update docs/frontend/custom-ui/custom-card-feature.md

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

* Update docs/frontend/custom-ui/custom-card-feature.md

* Apply suggestions from code review

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Bram Kragten <mail@bramkragten.nl>
2024-07-24 22:10:09 +02:00
J. Nick Koston
1da399a9b9 Add guide for handling asyncio blocking operations (#2225) 2024-06-21 12:55:36 -05:00
Paulus Schoutsen
1f235a8d53 Document the LLM helper (#2178)
* Document the LLM helper

* Incorporate other PR

* Apply suggestions from code review

Co-authored-by: Michael Hansen <hansen.mike@gmail.com>

---------

Co-authored-by: Michael Hansen <hansen.mike@gmail.com>
2024-05-20 16:18:53 -04:00
J. Nick Koston
12b4fca263 Add asyncio thread safety docs (#2171) 2024-05-14 15:15:34 +02:00
Paulus Schoutsen
3ce212327c Add converation entity docs (#2132)
* Add converation entity docs

* Fix links
2024-04-02 12:52:48 -04:00
Erik Montnemery
9b8f42920d Document integration tests file structure (#2118) 2024-03-22 02:36:39 +01:00
Stefan Agner
57e0de8129 Document Home Assistant OS update system (#2069)
* Document Home Assistant OS update system

Document the update system used in Home Assitant. This aims to help
developers to understand our update system and use it also during
development, so they can test development builds and iterate quickly.

* Add Update System to sidebar

* Apply suggestions from code review

Co-authored-by: Jan Čermák <sairon@users.noreply.github.com>
2024-02-06 17:59:45 +01:00
Jan Bouwhuis
f85fa4cbbb Add ServiceValidationError and translation support (#1961)
* Add ServiceValidationError and translation support

* Improvements, add blog post

* Add error handling response

* Follow up comment

* Update blog/2023-10-29-service-exceptions-and-translations.md

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

* Update blog/2023-10-29-service-exceptions-and-translations.md

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

* Follow up raising vs handling errors

* Fix links

* Update docs/core/platform/raising_exceptions.md

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

* Update blog/2023-10-29-service-exceptions-and-translations.md

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

* Update docs/api/websocket.md

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

* Update docs/internationalization/core.md

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

* Update docs/internationalization/core.md

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

* Update docs/core/platform/raising_exceptions.md

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

* Update docs/integration_quality_scale_index.md

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

* Update docs/internationalization/core.md

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

* Update blog/2023-10-29-service-exceptions-and-translations.md

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

* Rename file to adjust date

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-11-17 15:36:19 +01:00
Philip Allgaier
1b5a0e5b01 Add info about design portal to frontend dev docs (#1796)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2023-07-23 21:56:11 +02:00
Michael Hansen
93139737ff Add documentation for pipeline WebSocket API (#1722)
* Add docs for pipelines

* Minor changes

* Fix parameter

* Fix other parameter
2023-03-20 23:59:32 -04:00
Franck Nijhof
17eaaa515c Add generic page on the PR review process (#1693)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-02-22 10:30:06 +01:00
Paulus Schoutsen
2c2a7b2591 Add response style guide for voice (#1681)
* Add response style guide for voice

* Update style-guide.md

* Update style-guide.md
2023-02-14 11:06:10 -06:00
Michael Hansen
edb54bc87b Add "contributing your voice" page (#1642)
* Add "contributing your voice" page

* Update docs/voice/contributing-your-voice.md

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
2023-01-20 21:18:09 -05:00
J. Nick Koston
09856c97b2 Split Bluetooth APIs to their own page (#1641)
* Split Bluetooth APIs to their own page

* Split Bluetooth APIs to their own page

* Split Bluetooth APIs to their own page
2023-01-20 14:34:26 -05:00
J. Nick Koston
4d368a1b0f Add docs on fetching Bluetooth data (#1635)
* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Add docs on fetching Bluetooth data

* Update docs/bluetooth_fetching_data.md

* Update docs/bluetooth_fetching_data.md

* Update docs/bluetooth_fetching_data.md

Co-authored-by: 930913 <3722064+930913@users.noreply.github.com>

* Update docs/bluetooth_fetching_data.md

Co-authored-by: 930913 <3722064+930913@users.noreply.github.com>

* Update docs/bluetooth_fetching_data.md

* Update docs/bluetooth_fetching_data.md

Co-authored-by: 930913 <3722064+930913@users.noreply.github.com>

* Update docs/bluetooth_fetching_data.md

Co-authored-by: 930913 <3722064+930913@users.noreply.github.com>

* Update docs/bluetooth_fetching_data.md

* Adjust sidebar

* Fix link

Co-authored-by: 930913 <3722064+930913@users.noreply.github.com>
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
2023-01-19 21:50:27 -05:00
Paulus Schoutsen
b27e3c25e0 Documenet conversation WS API (#1636) 2023-01-19 09:53:17 -06:00
Paulus Schoutsen
976ff393b9 Document custom conversation agent (#1628) 2023-01-16 13:29:19 -05: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
Paulus Schoutsen
cae42c9fe3 Tweaks to intent docs (#1618)
* Tweaks to intent docs

* Move to core section

* Update docs/intent_firing.md
2023-01-09 10:22:51 -05:00
Michael Hansen
fa5380a68e Add conversation API to intents section (#1583)
* Add conversation API to intents section

* Add multiple targets

* Separate conversation id from intent response

* Add description of target combinations

* Update docs/intent_conversation_api.md

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>

* Update docs/intent_conversation_api.md

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>

* Language is required in intent response

* Add partial_action_done

* Remove partial_action_done

* Update docs/intent_conversation_api.md

* Fix examples

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
2022-12-13 23:02:59 -05:00
Erik Montnemery
49132570dd Document brand files (#1475)
* Document brand files

* Update docs/creating_integration_brand.md

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

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-09-30 08:39:15 +02:00
J. Nick Koston
8de815f0a8 Split bluetooth docs on to their own page (#1454)
Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
2022-08-29 21:27:48 -04:00
Erik Montnemery
63ce526339 Document the issue registry (#1447)
* Document the issue registry

* Apply suggestions from code review

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

* Tweak language

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-08-29 13:54:04 +02:00
J. Nick Koston
f6d2da20b3 Document how to handle integration setup failures (#1360) 2022-06-11 08:56:55 -10:00
Raman Gupta
520302a1e3 Add tips and tricks page (#1241) 2022-05-14 17:34:38 -05:00
J. Nick Koston
9bfb5df420 Add docs on listening for events (#1296)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2022-04-20 13:20:25 +02:00
Brandon Rothweiler
5f84f5d612 Remove mentions of the retired term "Lovelace" (#1292) 2022-04-18 11:22:59 -07:00
Joakim Sørensen
da18c9cbdb Add backup documentation and restructure platforms (#1259) 2022-03-30 21:40:23 +02:00
Franck Nijhof
5ab770d4ee Add update entity platform (#1243)
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-03-21 11:03:19 +01:00
Joakim Sørensen
6b93bcb0f6 Add buttton entity to navigation (#1125) 2021-11-04 19:38:28 +01:00
Stefan Agner
020a41fd18 Extend OS development docs (#1075)
* Add Operating System developer documentation

This moves some of the existing documentation from the operating-system
repository, updates it to reflect the current state and extens certain
parts.

* Reword and add deployment documentation

* Add new pages to Sidebar

* Reword and extend various aspects

* Small fixes here and there

* Clarify builds
2021-10-18 14:00:25 +02:00
J. Nick Koston
a9bb9a4fe9 Add camera entity docs (#1020) 2021-08-11 14:56:47 -05:00
Charles Garwood
395f1e0fa3 Merge pull request #865 from raman325/siren
Add entity doc for siren platform
2021-07-11 19:51:10 -04:00
raman325
2cef84ae81 Add siren to sidebar 2021-07-07 00:17:46 -04:00