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

Commit 609cff5

Browse files
authored
Replace docs with the latest from next (#2642)
1 parent a28234a commit 609cff5

File tree

291 files changed

+43732
-59410
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

291 files changed

+43732
-59410
lines changed

docs/Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ group :jekyll_plugins do
2525
gem 'jekyll-octicons'
2626
gem 'jekyll-readme-index'
2727
gem 'jekyll-mentions'
28+
gem 'jekyll-toc'
2829
gem 'jemoji'
2930
end
3031

docs/Gemfile.lock

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,8 @@ GEM
188188
jekyll-seo-tag (~> 2.0)
189189
jekyll-titles-from-headings (0.5.1)
190190
jekyll (~> 3.3)
191+
jekyll-toc (0.12.2)
192+
nokogiri (~> 1.9)
191193
jekyll-watch (2.2.1)
192194
listen (~> 3.0)
193195
jemoji (0.10.2)
@@ -255,6 +257,7 @@ DEPENDENCIES
255257
jekyll-readme-index
256258
jekyll-redirect-from
257259
jekyll-sitemap
260+
jekyll-toc
258261
jemoji
259262
minima (~> 2.0)
260263
wdm (~> 0.1.0)

docs/_config.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ defaults:
2727

2828
# Build settings
2929
markdown: kramdown
30+
highlighter: rouge
3031

3132
sass:
3233
style: :compressed
@@ -41,4 +42,16 @@ plugins:
4142
- jekyll-mentions
4243
- jekyll-octicons
4344
- jekyll-sitemap
45+
- jekyll-toc
46+
- jekyll-rouge
4447
- jemoji
48+
49+
toc:
50+
# Default is "section-nav":
51+
list_class: nav flex-column
52+
# Default is no class for sublists:
53+
sublist_class: nav flex-column
54+
# Default is "toc-entry":
55+
item_class: nav-item no-underline py-1 text-gray-light
56+
# Default is "toc-":
57+
item_prefix: nav-item-

docs/_data/toc.yml

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
Overview:
2+
Virtual Assistant:
3+
- Create
4+
- Customize
5+
- Deploy
6+
- Handbook
7+
Skills:
8+
- Create
9+
- Customize
10+
- Connect to a sample
11+
- Convert a v4 Bot
12+
- Extend a v4 Bot
13+
- Handbook
214
- Samples
3-
Tutorials:
4-
- Create a Virtual Assistant
5-
- Customize a Virtual Assistant
6-
- Create a skill
7-
- Customize a skill
8-
- Enable Speech
9-
- Enable Microsoft Teams
10-
How To:
11-
- Virtual Assistant
12-
- Skills
15+
Solution Accelerators:
16+
- Assistants
1317
- Samples
14-
Reference:
15-
- Virtual Assistant
16-
- Skills
17-
- Analytics
18-
- Samples
19-
Help:
18+
- Enable proactive notifications
19+
- View analytics using Power BI
20+
Clients and Channels:
21+
- Clients
22+
- Channels
23+
- Extend to Direct Line Speech
24+
- Extend to Microsoft Teams
25+
Help:
26+
- Reference

docs/_docs/_samples/_default.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ subcategory:
44
language:
55
title:
66
order: 1
7+
toc: true
78
---

docs/_docs/_samples/_howto.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/_docs/_samples/_reference.md

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: tutorial
3+
category: Tutorials
4+
subcategory: [Tutorial Name]
5+
title: Intro
6+
language: [C#, TypeScript or None]
7+
order: 1
8+
---
9+
10+
# Tutorial: {{page.subcategory}} ({{page.language}})
11+
12+
## {{ page.title }}
13+
14+
### Purpose
15+
16+
### Prerequisites
17+
18+
### Time To Complete
19+
20+
### Scenario

docs/_docs/_samples/_tutorial.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@ subcategory: [Tutorial Name]
55
title: Intro
66
language: [C#, TypeScript or None]
77
order: 1
8-
---
8+
---
9+
10+
# Tutorial: {{page.subcategory}} ({{page.language}})
11+
12+
## {{ page.title }}
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
category: Clients and Channels
3+
subcategory: Clients
4+
title: Event Companion (Android)
5+
description: The **Event Companion** app enables you to create widgets that will responds to custom events sent from your Virtual Assistant
6+
order: 2
7+
toc: true
8+
---
9+
# {{ page.title }}
10+
{:.no_toc}
11+
{{page.description}}
12+
13+
## Architecture
14+
![Virtual Assistant Client (Android) overview diagram]({{site.baseurl}}/assets/images/android-virtual-assistant-client-architecture.png)
15+
16+
## Prerequisites
17+
1. Set up your own [Virtual Assistant Client]({{site.baseurl}}/clients-and-channels/clients/virtual-assistant-client).
18+
19+
1. Download the [Event Companion app source code]({{site.repo}}/tree/next/samples/android/clients/EventCompanion).
20+
21+
## Build and run
22+
### Run
23+
{:.no_toc}
24+
[Build and run your app](https://developer.android.com/studio/run) to deploy to the Android Emulator or a connected device.
25+
26+
## Create new widgets
27+
28+
Create sample numeric and toggle widgets.
29+
30+
Numeric widgets and toggle widgets are available in Event Companion app for now.
31+
![Event Companion app widgets]({{site.baseurl}}/assets/images/android-event-companion-widgets.jpg)
32+
33+
### Numeric widget
34+
{:.no_toc}
35+
1. Long press on a blank area of the home screen, then select **Widgets**.
36+
37+
1. Select a numeric widget and drag onto the the home screen.
38+
39+
1. Configure:
40+
- **Label**: Widget label
41+
- **Event**: The name value of an event activity
42+
- **Icon**: Widget icon
43+
Predefined templates are available to populate a numeric widget for common scenarios.
44+
![Numeric widget]({{site.baseurl}}/assets/images/android-event-companion-numeric-widget-configuration.jpg)
45+
46+
1. Click **Add Widget** to finish placing on the home screen.
47+
48+
### Toggle widget
49+
{:.no_toc}
50+
1. Long press on a blank area of the home screen, then select **Widgets**.
51+
52+
1. Select a toggle widget and drag onto the the home screen.
53+
54+
1. Configure:
55+
- **Label**: Widget label
56+
- **Event**: The name value of an event activity
57+
- **Icon**: Widget icon
58+
Predefined templates are available to populate a toggle widget for common scenarios.
59+
![Toggle widget]({{site.baseurl}}/assets/images/android-event-companion-toggle-widget-configuration.jpg)
60+
61+
1. Click **Add Widget** to finish setting up the widget.
62+
63+
## Manage widgets
64+
All created widgets can be reconfigured from the main screen of the **Event Companion** app.
65+
![Event companion manage widgets]({{site.baseurl}}/assets/images/android-event-companion-manage-widgets.jpg)
66+
67+
1. Select the widget which needs to be reconfigured.
68+
69+
1. Modify properties.
70+
71+
1. Select **Save Widget** to apply the changes.

0 commit comments

Comments
 (0)