jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 09:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update voice contribuiton docs (#1630)

Browse Source
This commit is contained in:
Paulus Schoutsen 2023-01-16 13:32:31 -05:00 committed by GitHub
parent 976ff393b9
commit 421aa7b81f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/voice/intent-recognition/contributing.md
View File

@ -3,7 +3,12 @@ title: "Contributing template sentences"
sidebar_label: "Contributing sentences" sidebar_label: "Contributing sentences"
--- ---
Template sentences need to be contributed to our [Intents repository on GitHub](https://github.com/home-assistant/intents). The sentences will be reviewed by [the language leaders](../language-leaders.md) and merged if they are correct. You can either contribute new sentences or improve existing ones. See [the format page](template-sentence-syntax) on how the repostory is structured. Template sentences need to be contributed to our [Intents repository on GitHub](https://github.com/home-assistant/intents). The sentences will be reviewed by [the language leaders](../language-leaders) and merged if they are correct. You can either contribute new sentences or improve existing ones.
The Intent repository is structured as follows:
- `sentences/<language>/` - Template sentences for each language - [learn more](template-sentence-syntax)
- `tests/<language>/` - Tests for each language - [learn more](test-syntax)
We prefer a lot of small contributions over a few large ones. Contributions that contain a lot of changes are hard to review. That's why we want each contribution limited to a single language and single domain. We prefer a lot of small contributions over a few large ones. Contributions that contain a lot of changes are hard to review. That's why we want each contribution limited to a single language and single domain.

2
docs/voice/intent-recognition/template-sentence-syntax.md
View File

@ -2,7 +2,7 @@
title: "Template Sentence Syntax" title: "Template Sentence Syntax"
--- ---
Template sentences are defined in YAML files using the format of [Hassil, our template matcher](https://github.com/home-assistant/hassil). Our template sentences are stored [on GitHub](https://github.com/home-assistant/intents/tree/main/sentences) and are organized by having for each language a directory of files: Template sentences are defined in YAML files using the format of [Hassil, our template matcher](https://github.com/home-assistant/hassil). Our template sentences are stored [on GitHub](https://github.com/home-assistant/intents/tree/main/sentences) and are organized by having for each language a directory of files in `sentences/<language>/`:
- `_common.yaml` - Lists, expansion rules and skip words to be used across all template sentences. - `_common.yaml` - Lists, expansion rules and skip words to be used across all template sentences.
- `<domain>_<intent>.yaml` - Template sentences for a [single intent](../../intent_builtin) and domain. - `<domain>_<intent>.yaml` - Template sentences for a [single intent](../../intent_builtin) and domain.

2
docs/voice/intent-recognition/test-syntax.md
View File

@ -5,7 +5,7 @@ sidebar_label: "Test Syntax"
To ensure that the template sentences work as expected, we have an extensive test suite. This test suite is based on YAML files that contain a list of input sentences and the expected matched intent and slots. To ensure that the template sentences work as expected, we have an extensive test suite. This test suite is based on YAML files that contain a list of input sentences and the expected matched intent and slots.
The tests are stored [on GitHub](https://github.com/home-assistant/intents/tree/main/tests) and are organized by having for each language a directory of files: The tests are stored [on GitHub](https://github.com/home-assistant/intents/tree/main/tests) and are organized by having for each language a directory of files `tests/<language>/`:
- `_fixtures.yaml` - Fake entities and areas that can be referenced during testing - `_fixtures.yaml` - Fake entities and areas that can be referenced during testing
- `<domain>_<intent>.yaml` - Sentences for a [single intent](../../intent_builtin) and domain. These files should only test sentences that are defined in the [match sentences file](./template-sentence-syntax) with the same name. - `<domain>_<intent>.yaml` - Sentences for a [single intent](../../intent_builtin) and domain. These files should only test sentences that are defined in the [match sentences file](./template-sentence-syntax) with the same name.