Skip to content

Commit ce25845

Browse files
c0ffeeca7c0ffeeca7
authored
Voice control create separate section in docs (home-assistant#27586)
1 parent 4b94ee3 commit ce25845

27 files changed

+97
-56
lines changed

‎source/_includes/asides/docs_navigation.html

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,6 @@ <h1 class="title delta">Topics</h1>
3939
</li>
4040
</ul>
4141
</li>
42-
<li>
43-
<b>{% active_link /docs/assist/ Assist %}</b>
44-
<ul>
45-
<li>{% active_link /docs/assist/android/ Assist for Android %}</li>
46-
<li>{% active_link /docs/assist/apple/ Assist for Apple devices %}</li>
47-
<li>{% active_link /docs/assist/builtin_sentences/ Built-in sentences %}</li>
48-
<li>{% active_link /docs/assist/custom_sentences/ Custom sentences %}</li>
49-
<li>{% active_link /docs/assist/using_voice_assistants_overview/ Voice assistants - overview %}</li>
50-
<li>{% active_link /docs/assist/voice_remote_expose_devices/ Exposing devices to your voice assistant %}</li>
51-
<li>{% active_link /docs/assist/voice_remote_local_assistant/ Configuring a local assistant %}</li>
52-
<li>{% active_link /docs/assist/troubleshooting/ Troubleshooting Assist %}</li>
53-
<li>{% active_link /projects/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
54-
<li>{% active_link /projects/thirteen-usd-voice-remote/ Tutorial: $13 voice remote %}
55-
</li>
56-
</ul>
57-
</li>
5842
<li>
5943
<b>{% active_link /docs/energy/ Home Energy Management %}</b>
6044
<ul>

‎source/_includes/asides/voice_navigation.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<section class="aside-module grid__item one-whole lap-one-half">
2+
{% assign elements = site.dashboards | sort_natural: 'title' %}
3+
4+
<div class="section">
5+
<h1 class="title delta">Devices</h1>
6+
<ul class="divided sidebar-menu">
7+
<li>{% active_link /voice_control/android/ Assist for Android %}</li>
8+
<li>{% active_link /voice_control/apple/ Assist for Apple %}</li>
9+
</ul>
10+
</div>
11+
12+
<div class="section">
13+
<h1 class="title delta">Voice assistants</h1>
14+
<ul class="divided sidebar-menu">
15+
<li>{% active_link /voice_control/using_voice_assistants_overview/ Voice assistants: Overview %}</li>
16+
<li>{% active_link /voice_control/voice_remote_local_assistant/ Configuring a local assistant %}</li>
17+
<li>{% active_link /voice_control/voice_remote_expose_devices/ Exposing devices to voice assistant %}</li>
18+
<li>{% active_link /voice_control/builtin_sentences/ Built-in sentences %}</li>
19+
<li>{% active_link /voice_control/custom_sentences/ Custom sentences %}</li>
20+
<li>{% active_link /voice_control/troubleshooting/ Troubleshooting Assist %}</li>
21+
</ul>
22+
</div>
23+
24+
<div class="section">
25+
<h1 class="title delta">Projects</h1>
26+
<ul class="divided sidebar-menu">
27+
<li>{% active_link /voice_control/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
28+
<li>{% active_link /voice_control/thirteen-usd-voice-remote/ Tutorial: $13 voice remote %}</li>
29+
</ul>
30+
</div>
31+
</section>

‎source/_includes/site/header.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@
4141
<li>
4242
<a href="/dashboards/">Dashboards</a>
4343
</li>
44+
<li>
45+
<a href="/voice_control/">Voice control</a>
46+
</li>
4447
</ul>
4548
</li>
4649
<li><a href="/integrations/">Integrations</a></li>

‎source/_includes/site/sidebar.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
{% include asides/docs_navigation.html %}
2020
{% elsif root == 'faq' %}
2121
{% include asides/faq_navigation.html %}
22+
{% elsif root == 'voice_control' %}
23+
{% include asides/voice_navigation.html %}
2224
{% elsif root == 'hassio' or root == 'addons' %}
2325
{% include asides/hassio_navigation.html %}
2426
{% elsif root == 'cloud' %}

‎source/_integrations/assist_pipeline.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ha_platforms:
1515
- select
1616
---
1717

18-
The Assist pipeline integration provides the foundation for the [Assist](/docs/assist/) voice assistant in Home Assistant.
18+
The Assist pipeline integration provides the foundation for the [Assist](/voice_control/) voice assistant in Home Assistant.
1919

2020
For most users, there is no need to install this integration manually. The Assist pipeline integration is part of the default configuration and is set up automatically if needed by other integrations.
2121
If you are not using the default integration, you need to add the following to your `configuration.yaml` file:
@@ -25,4 +25,4 @@ If you are not using the default integration, you need to add the following to y
2525
assist_pipeline:
2626
```
2727
28-
For more information, refer to the procedure on [configuring a pipeline](/docs/assist/voice_remote_local_assistant/).
28+
For more information, refer to the procedure on [configuring a pipeline](/voice_control/voice_remote_local_assistant/).

‎source/_integrations/voice_assistant.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ ha_integration_type: integration
1313
ha_quality_scale: internal
1414
---
1515

16-
The Voice Assistant integration contains logic for running *pipelines*, which perform the common steps of a voice assistant like [Assist](/docs/assist/).
16+
The Voice Assistant integration contains logic for running *pipelines*, which perform the common steps of a voice assistant like [Assist](/voice_control/).

‎source/_integrations/voip.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ha_platforms:
1818
ha_config_flow: true
1919
---
2020

21-
The VoIP integration enables users to talk to [Assist](/docs/assist) using an analog phone and a VoIP adapter. Currently, the system works with the [Grandstream HT801](https://amzn.to/40k7mRa). See [the tutorial](/projects/worlds-most-private-voice-assistant) for detailed instructions.
21+
The VoIP integration enables users to talk to [Assist](/voice_control/) using an analog phone and a VoIP adapter. Currently, the system works with the [Grandstream HT801](https://amzn.to/40k7mRa). See [the tutorial](/projects/worlds-most-private-voice-assistant) for detailed instructions.
2222

2323
As an alternative, the [Grandstream HT802](https://www.amazon.com/Grandstream-GS-HT802-Analog-Telephone-Adapter/dp/B01JH7MYKA/) can be used, which is basically the same as the previously mentioned HT801, but has two phone ports, of which Home Assistant currently support using only one of them.
2424

‎source/_integrations/wyoming.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ha_platforms:
1616
ha_config_flow: true
1717
---
1818

19-
The Wyoming integration connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/docs/assist) to use a variety of local [speech-to-text](/integrations/stt/) and [text-to-speech](/integrations/tts/) systems, such as:
19+
The Wyoming integration connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/) and [text-to-speech](/integrations/tts/) systems, such as:
2020

2121
* Whisper {% my supervisor_addon badge addon="core_whisper" %}
2222
* Piper {% my supervisor_addon badge addon="core_piper" %}

‎source/_posts/2023-01-26-year-of-the-voice-chapter-1.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ We want Assist to be as accessible to as many people as possible. To do this, we
3232

3333
Assist is enabled by default in the Home Assistant 2023.2 release. Tap the new Assist icon <img src='/images/assist/assist-icon.svg' alt='Assist icon' style='height: 32px' class='no-shadow'> at the top right of the dashboard to use it.
3434

35-
[Assist documentation.](https://www.home-assistant.io/docs/assist/)
35+
[Assist documentation.](https://www.home-assistant.io/voice_control/)
3636

3737
<img src="/images/blog/2023-01-26-year-of-the-voice-chapter-1/assist-dialog.png" alt="Screenshot of the Assist dialog" class='no-shadow' />
3838

3939
## Assist on Android Wear
4040

4141
We want to make it as easy as possible to use Assist. To enable this for Android users, we have added a new tile to the Android Wear app. A simple swipe from the clock face will show the assist button and allows you to send voice commands.
4242

43-
[Assist on Android Wear documentation.](https://www.home-assistant.io/docs/assist/android/)
43+
[Assist on Android Wear documentation.](https://www.home-assistant.io/voice_control/android/)
4444

4545
_The tile is available in [Home Assistant Companion for Android 2023.1.1](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)._
4646

@@ -50,7 +50,7 @@ _The tile is available in [Home Assistant Companion for Android 2023.1.1](https:
5050

5151
For Apple devices we have been able to create a fully hands-free experience by integrating with Siri. This is powered by a new Apple Shortcut action called Assist, which is part of the Home Assistant app. This shortcut action can also be manually triggered from your Mac taskbar, iPhone home screen or Apple Watch complication. We have two ready-made shortcuts that users can import from the documentation with a single tap to unlock these features.
5252

53-
[Assist via Siri and Apple Shortcuts documentation.](https://www.home-assistant.io/docs/assist/apple/)
53+
[Assist via Siri and Apple Shortcuts documentation.](https://www.home-assistant.io/voice_control/apple/)
5454

5555
_The Assist shortcut is available in [Home Assistant Companion for iOS 2023.2](https://apps.apple.com/us/app/home-assistant/id1099568401?itsct=apps_box_badge&itscg=30200). Mac version is awaiting approval._
5656

@@ -66,7 +66,7 @@ With Home Assistant we believe that every home is uniquely yours and that [techn
6666

6767
Assist includes support for custom sentences, responses and intents, allowing you to achieve all of the above, and more. We've designed the custom sentence format in a way that it can be easily shared with the community.
6868

69-
Read [the documentation](https://www.home-assistant.io/docs/assist/custom_sentences) on how to get started.
69+
Read [the documentation](https://www.home-assistant.io/voice_control/custom_sentences) on how to get started.
7070

7171
_In a future release we're planning on adding a user interface to customize and import sentences._
7272

‎source/_posts/2023-02-01-release-20232.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Go ahead, it is enabled by default; just tap the new Assist icon
8989
at the top right of your dashboard to start using it.
9090

9191
Oh, and we are also releasing some fun stuff we've cooked up along the way!
92-
[Read more about Assist](/docs/assist/) and other released voice features in the
92+
[Read more about Assist](/voice_control/) and other released voice features in the
9393
[Chapter 1: Assist](/blog/2023/01/26/year-of-the-voice-chapter-1/) blogpost
9494
and a [video presentation (including live demos) on YouTube](https://www.youtube.com/live/ixgNT3RETPg).
9595

‎source/_posts/2023-04-27-year-of-the-voice-chapter-2.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ _To watch the video presentation of this blog post, including live demos, check
2727
[Chapter 1]: https://www.home-assistant.io/blog/2023/01/26/year-of-the-voice-chapter-1/
2828
[45 languages]: https://home-assistant.github.io/intents/
2929
[live-stream]: https://youtube.com/live/Tk-pnm7FY7c?feature=share
30-
[assist]: /docs/assist/
30+
[assist]: /voice_control/
3131

3232
<!--more-->
3333

@@ -52,7 +52,7 @@ Screenshot of the new Assist debug tool.
5252
</p>
5353

5454
[Assist Pipeline integration]: https://www.home-assistant.io/integrations/assist_pipeline/
55-
[Assist dialog]: /docs/assist/
55+
[Assist dialog]: /voice_control/
5656

5757
## Voice Assistant powered by Home Assistant Cloud
5858

@@ -131,7 +131,7 @@ Today we’re launching support for building voice assistants using ESPHome. Con
131131

132132
We’ve been focusing on the [M5STACK ATOM Echo][atom-echo] for testing and development. For $13 it comes with a microphone and a speaker in a nice little box. We’ve created a tutorial to turn this device into a voice remote directly from your browser!
133133

134-
[Tutorial: create a $13 voice remote for Home Assistant.](https://www.home-assistant.io/projects/thirteen-usd-voice-remote/)
134+
[Tutorial: create a $13 voice remote for Home Assistant.](https://www.home-assistant.io/voice_control/thirteen-usd-voice-remote/)
135135

136136
[ESPHome Voice Assistant documentation.](https://esphome.io/components/voice_assistant.html)
137137

@@ -152,7 +152,7 @@ By configuring off-hook autodial, your phone will automatically call Home Assist
152152

153153
We’ve focused our initial efforts on supporting [the Grandstream HT801 Voice-over-IP box][ht801]. It works with any phone with an RJ11 connector, and connects directly to Home Assistant. There is no need for an extra server.
154154

155-
[Tutorial: create your own World’s Most Private Voice Assistant](https://www.home-assistant.io/projects/worlds-most-private-voice-assistant/)
155+
[Tutorial: create your own World’s Most Private Voice Assistant](https://www.home-assistant.io/voice_control/worlds-most-private-voice-assistant/)
156156

157157

158158
<p class='img'>

‎source/_posts/2023-05-03-release-20235.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,10 @@ To help you get started, we made sure the documentation is perfect, including
8787
some cool project tutorials to jump-start your own private voice assistant
8888
journey:
8989

90-
- [The world's most private voice assistant](/projects/worlds-most-private-voice-assistant/)
91-
- [Giving your voice assistant a Super Mario personality using OpenAI](/projects/worlds-most-private-voice-assistant/#give-your-voice-assistant-personality-using-the-openai-integration)
92-
- [Installing a local Assist pipeline](/docs/assist/voice_remote_local_assistant/)
93-
- [The $13 tiny ESPHome-based voice assistant](/projects/thirteen-usd-voice-remote/)
90+
- [The world's most private voice assistant](/voice_control/worlds-most-private-voice-assistant/)
91+
- [Giving your voice assistant a Super Mario personality using OpenAI](/voice_control/worlds-most-private-voice-assistant/#give-your-voice-assistant-personality-using-the-openai-integration)
92+
- [Installing a local Assist pipeline](/voice_control/voice_remote_local_assistant/)
93+
- [The $13 tiny ESPHome-based voice assistant](/voice_control/thirteen-usd-voice-remote/)
9494

9595
If you missed [last week's live stream](https://www.youtube.com/watch?v=Tk-pnm7FY7c),
9696
be sure to check it out. It is full of live demos and detailed explanations
@@ -123,7 +123,7 @@ manage the entity's aliases.
123123

124124
<img class="no-shadow" src='/images/blog/2023-05/voice-assistants-expose-entities-settings.png' alt='Screenshot showing the new expose entities tab in the voice assistants menu.'>
125125

126-
This currently supports our [Assist](/docs/assist), and Amazon Alexa and
126+
This currently supports our [Assist](/voice_control/), and Amazon Alexa and
127127
Google Assistant via Home Assistant Cloud.
128128

129129
## Improved entity setting
@@ -277,7 +277,7 @@ findability. This one is new:
277277
[@tronikos]: https://github.com/tronikos
278278
[android tv remote]: /integrations/androidtv_remote
279279
[Anova]: /integrations/anova
280-
[assist]: /docs/assist
280+
[assist]: /voice_control/
281281
[Intellifire]: /integrations/intellifire
282282
[Monessen]: /integrations/monessen
283283
[RAPT Bluetooth]: /integrations/rapt_ble

‎source/_redirects

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,17 @@ layout: null
218218
# Moved documentation
219219
/details/database /docs/backend/database
220220
/details/updater /docs/backend/updater
221+
/docs/assist/ /voice_control/
222+
/docs/assist/android/ /voice_control/android/
223+
/docs/assist/apple/ /voice_control/apple/
224+
/docs/assist/builtin_sentences/ /voice_control/builtin_sentences/
225+
/docs/assist/custom_sentences/ /voice_control/custom_sentences/
226+
/docs/assist/using_voice_assistants_overview/ /voice_control/using_voice_assistants_overview/
227+
/docs/assist/voice_remote_expose_devices/ /voice_control/voice_remote_expose_devices/
228+
/docs/assist/voice_remote_local_assistant/ /voice_control/voice_remote_local_assistant/
229+
/docs/assist/troubleshooting/ /voice_control/troubleshooting/
230+
/docs/assist/worlds-most-private-voice-assistant/ /voice_control/worlds-most-private-voice-assistant/
231+
/docs/assist/thirteen-usd-voice-remote/ /voice_control/thirteen-usd-voice-remote/
221232
/docs/backend/updater /integrations/analytics
222233
/docs/ecosystem/ios/ https://companion.home-assistant.io/
223234
/docs/ecosystem/ios/devices_file https://companion.home-assistant.io/

‎source/docs/index.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ The documentation covers beginner to advanced topics around the installation, se
3737
</div>
3838
<div class='title'>Android and iOS</div>
3939
</a>
40+
<a class='option-card' href='/voice_control/'>
41+
<div class='img-container'>
42+
<img src='/images/assist/assist-icon.svg' />
43+
</div>
44+
<div class='title'>Voice control</div>
45+
</a>
4046
</div>
4147

4248
<br/>

‎source/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h1>Ok Google, turn on the AC</h1>
102102
></a>
103103
<!-- Tutorial: setup private voice assistant over phone -->
104104
<a
105-
href="/projects/worlds-most-private-voice-assistant/"
105+
href="/voice_control/worlds-most-private-voice-assistant/"
106106
target="_blank"
107107
class="material-card picture-promo"
108108
style="

‎source/docs/assist/aliases.markdown renamed to ‎source/voice_control/aliases.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Assist will use the names of your entities, as well as any aliases you've config
66

77
![Alias example](/images/blog/2023-01/aliases-cloud-multi-language.png)
88

9-
By adding aliases in your native language, you can speak to Home Assistant with the language configured on your [Android watch](/docs/assist/android/) or [Apple device](/docs/assist/apple/).
9+
By adding aliases in your native language, you can speak to Home Assistant with the language configured on your [Android watch](/voice_control/android/) or [Apple device](/voice_control/apple/).

‎source/docs/assist/android.markdown renamed to ‎source/voice_control/android.markdown

File renamed without changes.

‎source/docs/assist/apple.markdown renamed to ‎source/voice_control/apple.markdown

File renamed without changes.

‎source/docs/assist/builtin_sentences.markdown renamed to ‎source/voice_control/builtin_sentences.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ In addition to individual entities, commands can target **areas**:
2222
* *"change kitchen brightness to 50%"*
2323
* *"set bedroom lights to green"*
2424

25-
Entity [aliases](/docs/assist/aliases) are also matched so multiple names can be used, even in different languages.
25+
Entity [aliases](/voice_control/aliases) are also matched so multiple names can be used, even in different languages.
2626

27-
You can extend the built-in sentences or [add your own](/docs/assist/custom_sentences) to trigger any action in Home Assistant.
27+
You can extend the built-in sentences or [add your own](/voice_control/custom_sentences) to trigger any action in Home Assistant.
2828

2929
## View existing sentences
3030

@@ -55,6 +55,6 @@ To get an idea of the specific sentences that are supported for your language, y
5555
* () mean alternative elements.
5656
* [] mean optional elements.
5757
* <> mean an expansion rule. The view these rules, search for `expansion_rules` in the [_common.yaml](https://github.com/home-assistant/intents/blob/main/sentences/en/_common.yaml) file.
58-
* The syntax is explained in detail in the [template sentence syntax documentation](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax).
58+
* The syntax is explained in detail in the [template sentence syntax documentation](https://developers.home-assistant.io/docs/voice_control/intent-recognition/template-sentence-syntax).
5959

6060

‎source/docs/assist/custom_sentences.markdown renamed to ‎source/voice_control/custom_sentences.markdown

File renamed without changes.

‎source/docs/assist/index.markdown renamed to ‎source/voice_control/index.markdown

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@ title: Assist - Talking to Home Assistant
44

55
<img src='/images/assist/assist-logo.png' class='no-shadow' alt='Assist logo' style='width: 150px; float: right'>
66

7-
Assist is our feature to allow you to control Home Assistant using natural language. It is built on top of an open voice foundation and powered by knowledge provided by our community. You can use the [built-in sentences](/docs/assist/builtin_sentences) to control entities and areas, or [create your own](/docs/assist/custom_sentences).
7+
Assist is our feature to allow you to control Home Assistant using natural language. It is built on top of an open voice foundation and powered by knowledge provided by our community.
8+
9+
_Want to use Home Assistant with Google Assistant or Amazon Alexa? Get started with [Home Assistant Cloud](https://www.nabucasa.com/config/)._
10+
11+
With Assist, you can use the [built-in sentences](/voice_control/builtin_sentences) to control entities and areas, or [create your own](/voice_control/custom_sentences).
812

913
[List of supported languages.](https://developers.home-assistant.io/docs/voice/intent-recognition/supported-languages)
1014

1115
Assist is available to use on most platforms that can interface with Home Assistant. Look for the Assist icon <img src='/images/assist/assist-icon.svg' alt='Assist icon' style='height: 32px' class='no-shadow'>:
1216

1317
- Inside the Home Assistant app in the top-right corner
14-
- On Apple devices via [Siri and Assist shortcuts](/docs/assist/apple)
15-
- On Wear OS watches using [Assist tile](/docs/assist/android)
18+
- On Apple devices via [Siri and Assist shortcuts](/voice_control/apple)
19+
- On Wear OS watches using [Assist tile](/voice_control/android)
1620

1721
Did Assist not understand your sentence? [Contribute them.](https://developers.home-assistant.io/docs/voice/intent-recognition/)
1822

0 commit comments

Comments
 (0)