From 421aa7b81f049dd066044e019db8a3556c0c9a3f Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 16 Jan 2023 13:32:31 -0500 Subject: [PATCH] Update voice contribuiton docs (#1630) --- docs/voice/intent-recognition/contributing.md | 7 ++++++- docs/voice/intent-recognition/template-sentence-syntax.md | 2 +- docs/voice/intent-recognition/test-syntax.md | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/voice/intent-recognition/contributing.md b/docs/voice/intent-recognition/contributing.md index 78a8dd2c..c20133dd 100644 --- a/docs/voice/intent-recognition/contributing.md +++ b/docs/voice/intent-recognition/contributing.md @@ -3,7 +3,12 @@ title: "Contributing template 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//` - Template sentences for each language - [learn more](template-sentence-syntax) +- `tests//` - 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. diff --git a/docs/voice/intent-recognition/template-sentence-syntax.md b/docs/voice/intent-recognition/template-sentence-syntax.md index 8f52501c..b0be4e18 100644 --- a/docs/voice/intent-recognition/template-sentence-syntax.md +++ b/docs/voice/intent-recognition/template-sentence-syntax.md @@ -2,7 +2,7 @@ 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//`: - `_common.yaml` - Lists, expansion rules and skip words to be used across all template sentences. - `_.yaml` - Template sentences for a [single intent](../../intent_builtin) and domain. diff --git a/docs/voice/intent-recognition/test-syntax.md b/docs/voice/intent-recognition/test-syntax.md index 6e9b0d65..717fda06 100644 --- a/docs/voice/intent-recognition/test-syntax.md +++ b/docs/voice/intent-recognition/test-syntax.md @@ -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. -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//`: - `_fixtures.yaml` - Fake entities and areas that can be referenced during testing - `_.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.