Ignite docs

docs/Gemfile

@@ -25,6 +25,7 @@ group :jekyll_plugins do
   gem 'jekyll-octicons'
   gem 'jekyll-readme-index'
   gem 'jekyll-mentions'
+  gem 'jekyll-toc'
   gem 'jemoji'
 end
 

docs/Gemfile.lock

@@ -188,6 +188,8 @@ GEM
       jekyll-seo-tag (~> 2.0)
     jekyll-titles-from-headings (0.5.1)
       jekyll (~> 3.3)
+    jekyll-toc (0.12.2)
+      nokogiri (~> 1.9)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     jemoji (0.10.2)
@@ -255,6 +257,7 @@ DEPENDENCIES
   jekyll-readme-index
   jekyll-redirect-from
   jekyll-sitemap
+  jekyll-toc
   jemoji
   minima (~> 2.0)
   wdm (~> 0.1.0)

docs/_config.yml

@@ -27,6 +27,7 @@ defaults:
 
 # Build settings
 markdown: kramdown
+highlighter: rouge
 
 sass:
   style: :compressed
@@ -41,4 +42,16 @@ plugins:
   - jekyll-mentions
   - jekyll-octicons
   - jekyll-sitemap
+  - jekyll-toc
+  - jekyll-rouge
   - jemoji  
+
+toc:
+  # Default is "section-nav":
+  list_class: nav flex-column
+  # Default is no class for sublists:
+  sublist_class: nav flex-column
+  # Default is "toc-entry":
+  item_class: nav-item no-underline py-1 text-gray-light
+  # Default is "toc-":
+  item_prefix: nav-item-

docs/_data/toc.yml

@@ -1,19 +1,26 @@
 Overview:
+Virtual Assistant:
+- Create
+- Customize
+- Deploy
+- Handbook
+Skills:
+- Create
+- Customize
+- Connect to a sample
+- Convert a v4 Bot
+- Extend a v4 Bot
+- Handbook
 - Samples
-Tutorials:
-- Create a Virtual Assistant
-- Customize a Virtual Assistant
-- Create a skill
-- Customize a skill
-- Enable Speech
-- Enable Microsoft Teams
-How To:
-- Virtual Assistant
-- Skills
+Solution Accelerators:
+- Assistants
 - Samples
-Reference:
-- Virtual Assistant
-- Skills
-- Analytics
-- Samples
-Help:
+- Enable proactive notifications
+- View analytics using Power BI
+Clients and Channels:
+- Clients
+- Channels
+- Extend to Direct Line Speech
+- Extend to Microsoft Teams
+Help:
+- Reference

docs/_docs/_samples/_default.md

@@ -4,4 +4,5 @@ subcategory:
 language:
 title: 
 order: 1
+toc: true
 ---

docs/_docs/_samples/_tutorial-intro.md

@@ -0,0 +1,20 @@
+---
+layout: tutorial
+category: Tutorials
+subcategory: [Tutorial Name]
+title: Intro
+language: [C#, TypeScript or None]
+order: 1
+---
+
+# Tutorial: {{page.subcategory}} ({{page.language}})
+
+## {{ page.title }}
+
+### Purpose
+
+### Prerequisites
+
+### Time To Complete
+
+### Scenario

docs/_docs/_samples/_tutorial.md

@@ -5,4 +5,8 @@ subcategory: [Tutorial Name]
 title: Intro
 language: [C#, TypeScript or None]
 order: 1
----
+---
+
+# Tutorial: {{page.subcategory}} ({{page.language}})
+
+## {{ page.title }}

docs/_docs/clients-and-channels/clients/event-companion.md

@@ -0,0 +1,71 @@
+---
+category: Clients and Channels
+subcategory: Clients
+title:  Event Companion (Android)
+description: The **Event Companion** app enables you to create widgets that will responds to custom events sent from your Virtual Assistant
+order: 2
+toc: true
+---
+# {{ page.title }}
+{:.no_toc}
+{{page.description}}
+
+## Architecture
+![Virtual Assistant Client (Android) overview diagram]({{site.baseurl}}/assets/images/android-virtual-assistant-client-architecture.png)
+
+## Prerequisites
+1. Set up your own [Virtual Assistant Client]({{site.baseurl}}/clients-and-channels/clients/virtual-assistant-client).
+
+1. Download the [Event Companion app source code]({{site.repo}}/tree/next/samples/android/clients/EventCompanion).
+
+## Build and run
+### Run
+{:.no_toc}
+[Build and run your app](https://developer.android.com/studio/run) to deploy to the Android Emulator or a connected device.
+
+## Create new widgets
+
+Create sample numeric and toggle widgets.
+
+Numeric widgets and toggle widgets are available in Event Companion app for now.
+![Event Companion app widgets]({{site.baseurl}}/assets/images/android-event-companion-widgets.jpg)
+
+### Numeric widget
+{:.no_toc}
+1. Long press on a blank area of the home screen, then select **Widgets**.
+
+1. Select a numeric widget and drag onto the the home screen.
+
+1. Configure:
+- **Label**: Widget label
+- **Event**: The name value of an event activity
+- **Icon**: Widget icon
+Predefined templates are available to populate a numeric widget for common scenarios.
+![Numeric widget]({{site.baseurl}}/assets/images/android-event-companion-numeric-widget-configuration.jpg)
+
+1. Click **Add Widget** to finish placing on the home screen.
+
+### Toggle widget
+{:.no_toc}
+1. Long press on a blank area of the home screen, then select **Widgets**.
+
+1. Select a toggle widget and drag onto the the home screen.
+
+1. Configure:
+- **Label**: Widget label
+- **Event**: The name value of an event activity
+- **Icon**: Widget icon
+Predefined templates are available to populate a toggle widget for common scenarios.
+![Toggle widget]({{site.baseurl}}/assets/images/android-event-companion-toggle-widget-configuration.jpg)
+
+1. Click **Add Widget** to finish setting up the widget.
+
+## Manage widgets
+All created widgets can be reconfigured from the main screen of the **Event Companion** app.
+![Event companion manage widgets]({{site.baseurl}}/assets/images/android-event-companion-manage-widgets.jpg)
+
+1. Select the widget which needs to be reconfigured.
+
+1. Modify properties.
+
+1. Select **Save Widget** to apply the changes.