Skip to content
This repository was archived by the owner on Jun 30, 2022. It is now read-only.

Commit 727b49a

Browse files
David Favrettodarrenj
authored andcommitted
[Documentation] Fix typos, broken links and stylings (#2414)
* Fix typos * Fix broken links * Fix indentation
1 parent cd49dde commit 727b49a

File tree

17 files changed

+433
-419
lines changed

17 files changed

+433
-419
lines changed

docs/_docs/reference/skills/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Within an Enterprise, this could be creating one parent bot bringing together mu
2323

2424
Skills are themselves Bots, invoked remotely and a Skill developer template (.NET, TS) is available to facilitate creation of new Skills.
2525

26-
A key design goal for Skills was to maintain the consistent Activity protocol and ensure the development experience was as close to any normal V4 SDK bot as possible. To that end, a Bot simply starts a `SkilllDialog` which abstracts the skill invocation mechanics.
26+
A key design goal for Skills was to maintain the consistent Activity protocol and ensure the development experience was as close to any normal V4 SDK bot as possible. To that end, a Bot simply starts a `SkillDialog` which abstracts the skill invocation mechanics.
2727

2828
## Invocation Flow
2929

@@ -32,7 +32,7 @@ A key design goal for Skills was to maintain the consistent Activity protocol an
3232
### Dispatcher
3333
{:.no_toc}
3434

35-
The Dispatcher plays a central role to enabling a Bot to understand how to best process a given utterance. The Dispatch through use of the [Skill CLI]({{site.baseurl}}/reference/botskills) is updated with triggering utterances for a given Skill and a new Dispatch intent is created for a given Skill. An example of a Dispatch model with a point of interest skill having been added is shown below.
35+
The Dispatcher plays a central role to enabling a Bot to understand how to best process a given utterance. The Dispatch through use of the [Skill CLI]({{site.baseurl}}/reference/skills/botskills) is updated with triggering utterances for a given Skill and a new Dispatch intent is created for a given Skill. An example of a Dispatch model with a point of interest skill having been added is shown below.
3636

3737
![Dispatch with Skill Example]({{site.baseurl}}/assets/images/skillarchitecturedispatchexample.png)
3838

docs/_docs/reference/skills/automotive.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ An example transcript file demonstrating the Skill in action can be found [here]
6363

6464
## Language Understanding (LUIS)
6565

66-
LUIS models for the Skill are provided in .LU file format as part of the Skill. These are currently available in English with other languages to follow.
66+
LUIS models for the Skill are provided in `.lu` file format as part of the Skill. These are currently available in English with other languages to follow.
6767

6868
The following Top Level intents are available with the main `settings` LUIS model
6969

@@ -131,36 +131,36 @@ The MSBot tool will outline the deployment plan including location and SKU. Ensu
131131

132132
> After deployment is complete, it's **imperative** that you make a note of the .bot file secret provided as this will be required for later steps. The secret can be found near the top of the execution output and will be in purple text.
133133
134-
- Update your `appsettings.json` file with the newly created .bot file name and .bot file secret.
134+
- Update your `appsettings.json` file with the newly created `.bot` file name and `.bot` file secret.
135135
- Run the following command and retrieve the InstrumentationKey for your Application Insights instance and update `InstrumentationKey` in your `appsettings.json` file.
136136

137137
```
138138
msbot list --bot YOURBOTFILE.bot --secret YOUR_BOT_SECRET
139139
```
140140

141141
```json
142-
{
143-
"botFilePath": ".//YOURBOTFILE.bot",
144-
"botFileSecret": "YOUR_BOT_SECRET",
145-
"ApplicationInsights": {
146-
"InstrumentationKey": "YOUR_INSTRUMENTATION_KEY"
147-
}
142+
{
143+
"botFilePath": ".//YOURBOTFILE.bot",
144+
"botFileSecret": "YOUR_BOT_SECRET",
145+
"ApplicationInsights": {
146+
"InstrumentationKey": "YOUR_INSTRUMENTATION_KEY"
148147
}
148+
}
149149
```
150150

151-
- Finally, add the .bot file paths for each of your language configurations (English only at this time).
151+
- Finally, add the `.bot` file paths for each of your language configurations (English only at this time).
152152

153153
```json
154154
"defaultLocale": "en-us",
155-
"languageModels": {
156-
"en": {
157-
"botFilePath": ".//LocaleConfigurations//YOUR_EN_BOT_PATH.bot",
158-
"botFileSecret": ""
159-
}
160-
}
155+
"languageModels": {
156+
"en": {
157+
"botFilePath": ".//LocaleConfigurations//YOUR_EN_BOT_PATH.bot",
158+
"botFileSecret": ""
159+
}
160+
}
161161
```
162162

163-
Once you have followed the deployment instructions above, open the provided .bot file with the Bot Framework Emulator.
163+
Once you have followed the deployment instructions above, open the provided `.bot` file with the Bot Framework Emulator.
164164

165165
### Adding the Skill to an existing Virtual Assistant deployment
166166

@@ -169,33 +169,33 @@ Follow the instructions below to add the Automotive Skill to an existing Virtual
169169
1. Update the Virtual Assistant deployment scripts.
170170
- Add the additional automotive skill LUIS models to the bot.recipe file located within your assistant project: `assistant/DeploymentScripts/en/bot.recipe`
171171

172-
```json
173-
{
174-
"type": "luis",
175-
"id": "settings",
176-
"name": "settings",
177-
"luPath": "../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings.lu"
178-
},
179-
{
180-
"type": "luis",
181-
"id": "settings_name",
182-
"name": "settings_name",
183-
"luPath": "../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings_name.lu"
184-
},
185-
{
186-
"type": "luis",
187-
"id": "settings_value",
188-
"name": "settings_value",
189-
"luPath": "../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings_value.lu"
190-
},
191-
```
192-
193-
- Add dispatch references to the core LUIS intents for the skill within the **assistant/CognitiveModels/en/dispatch.lu** file as shown below. Only the vehicle settings model is required for dispatch. This enables the Dispatcher to understand your new capabilities and route utterances to your skill
194-
195-
```
196-
# l_Automotive
197-
- [VEHICLE_SETTINGS_CHANGE](../../../../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings_dispatch.lu#VEHICLE_SETTINGS_CHANGE)
198-
```
172+
```json
173+
{
174+
"type": "luis",
175+
"id": "settings",
176+
"name": "settings",
177+
"luPath": "../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings.lu"
178+
},
179+
{
180+
"type": "luis",
181+
"id": "settings_name",
182+
"name": "settings_name",
183+
"luPath": "../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings_name.lu"
184+
},
185+
{
186+
"type": "luis",
187+
"id": "settings_value",
188+
"name": "settings_value",
189+
"luPath": "../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings_value.lu"
190+
},
191+
```
192+
193+
- Add dispatch references to the core LUIS intents for the skill within the **assistant/CognitiveModels/en/dispatch.lu** file as shown below. Only the vehicle settings model is required for dispatch. This enables the Dispatcher to understand your new capabilities and route utterances to your skill
194+
195+
```
196+
# l_Automotive
197+
- [VEHICLE_SETTINGS_CHANGE](../../../../skills/automotiveskill/automotiveskill/CognitiveModels/LUIS/en/settings_dispatch.lu#VEHICLE_SETTINGS_CHANGE)
198+
```
199199

200200
2. Run the following script to deploy the new Automotive Skill LUIS models and to update the dispatcher.
201201

0 commit comments

Comments
 (0)