Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor tweaks to titles and paragraphs #1379

Merged
merged 1 commit into from
Mar 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/api/endpoints/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
sidebar_label: Introduction
title: Overview
sidebar_label: Overview
---

The grouping of HTTP endpoints reflects the high-level entities of the [Airy
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/architecture.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: The Airy Core architecture
title: Airy Core architecture
sidebar_label: Architecture
---

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/getting-started/components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Airy Core Components
sidebar_label: Core Components
title: Components
sidebar_label: Components
---

import Image from "@site/src/components/Image";
Expand Down Expand Up @@ -58,7 +58,7 @@ Airy Core contains the following core components:
iconInvertible={true}
title='UI: From an inbox to dashboards'
description="Not every message can be handled by code, this is why Airy comes with different UIs ready for you and your teams to use."
link='/apps/ui/introduction'
link='/ui/introduction'
/>
<ButtonBox
icon={<GearSVG />}
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/installation/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Install Airy Core
sidebar_label: Introduction
sidebar_label: Installation
---

import TLDR from "@site/src/components/TLDR";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ started.

## Work with the code

The Airy Core uses [Bazel](https://bazel.build/) to build and test
Airy Core uses [Bazel](https://bazel.build/) to build and test
itself. We suggest you to install
[bazelisk](https://github.com/bazelbuild/bazelisk), a small utility that will
install the right version of Bazel for you.
Expand Down
12 changes: 6 additions & 6 deletions docs/docs/integrations/rasa.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ Airy Core to send and receive messages.

## Configuring Airy

The Airy Core can forward messages from your sources (Messenger,
WhatsApp etc.) to downstream messaging frameworks like Rasa, which can in turn
reply using the Airy Core API.
Airy Core can forward messages from your sources (Messenger, WhatsApp etc.) to
downstream messaging frameworks like Rasa, which can in turn reply using the
Airy Core API.

To do this we follow the [webhook documentation](api/webhook.md) to forward in-
and outbound messages to Rasa. When doing so set the `url` parameter so that it
Expand Down Expand Up @@ -98,9 +98,9 @@ channels.airy.AiryInput:

Now you should have a working integration 🎉.

To test the connection write a message to one of your channels: The Airy Core
Platform will forward it to your Rasa installation, which will respond using the
Airy Core API. This is what you should see in the logs of the demo repository:
To test the connection write a message to one of your channels: Airy Core will
forward it to your Rasa installation, which will respond using the Airy Core
API. This is what you should see in the logs of the demo repository:

<img alt="send message successful connection log"
src={useBaseUrl('img/integrations/rasa/success.jpg')} />
2 changes: 1 addition & 1 deletion docs/docs/sources/chatplugin/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Install the Airy Live Chat Plugin on your website
title: Website installation
sidebar_label: Installation
---

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/sources/chatplugin/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ChatPlugin Overview
title: Live Chat overview
sidebar_label: Overview
---

Expand Down Expand Up @@ -68,6 +68,6 @@ Airy’s Live Chat Plugin supports the following messages types:

**Samples**

| RichCard | RichCardCarousel | Emojis |
| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| <img alt="Rich Card Example" src={useBaseUrl('img/apps/ui/richCardChatpluginExample.gif')} /> | <img alt="Rich Card Carousel Example" src={useBaseUrl('img/apps/ui/richCardCarouselChatpluginExample.gif')} /> | <img alt="Emoji Example" src={useBaseUrl('img/apps/ui/emojiExample.png')} /> |
| RichCard | RichCardCarousel | Emojis |
| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| <img alt="Rich Card Example" src={useBaseUrl('img/ui/richCardChatpluginExample.gif')} /> | <img alt="Rich Card Carousel Example" src={useBaseUrl('img/ui/richCardCarouselChatpluginExample.gif')} /> | <img alt="Emoji Example" src={useBaseUrl('img/ui/emojiExample.png')} /> |
3 changes: 2 additions & 1 deletion docs/docs/sources/facebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ The Facebook source requires the following configuration:
- [Step 2: Configure the webhook integration](#step-2-configure-the-webhook-integration)
- [Step 3: Obtain the page token](#step-3-obtain-the-page-token)
- [Connect a Facebook page to your instance](#connect-a-facebook-page-to-your-instance)
- [Connect a Facebook source via API request](#connect-a-facebook-source-via-api-request)
- [Connect a Facebook source via the UI](#connect-a-facebook-source-via-the-ui)
- [Send messages from a Facebook source](#send-messages-from-a-facebook-source)
- [Send and receive messages with the Inbox UI](#send-and-receive-messages-with-the-inbox-ui)

Let's proceed step by step.

Expand Down
20 changes: 13 additions & 7 deletions docs/docs/sources/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,23 @@ Business Location and your running instance of Airy Core.

Google's Business Messages requires the following configuration:

- [Step 1: Registration](#step-1-registration)
- [Step 2: Editing of the yaml file in Airy Core](#step-2-editing-of-the-yaml-file-in-airy-core)
- [Step 3: Verification by Google](#step-3-verification-by-google)
- [Configuration](#configuration)
- [Step 1: Registration](#step-1-registration)
- [Step 2: Editing of the yaml file in Airy Core](#step-2-editing-of-the-yaml-file-in-airy-core)
- [Step 3: Verification by Google](#step-3-verification-by-google)
- [Connecting Google's Business Messages to your Airy Core instance](#connecting-googles-business-messages-to-your-airy-core-instance)
- [Send messages from Google's Business Messages source](#send-messages-from-googles-business-messages-source)

Let's proceed step by step.

## Step 1: Registration
### Step 1: Registration

You first need to be registered with Google's Business Messages before configuring this source. Refer to [Google's Business Messages' guides](https://developers.google.com/business-communications/business-messages/guides) to find more information about this source and the registration process.
You first need to be registered with Google's Business Messages before
configuring this source. Refer to [Google's Business Messages'
guides](https://developers.google.com/business-communications/business-messages/guides)
to find more information about this source and the registration process.

## Step 2: Editing of the yaml file in Airy Core
### Step 2: Editing of the yaml file in Airy Core

Once you are registered, head over to your Google Service Account and create a key in json format.

Expand All @@ -53,7 +59,7 @@ Copy the Google Service Account key file provided by Google to
GOOGLE_SA_FILE=<CONTENT OF THE FILE>
```

## Step 3: Verification by Google
### Step 3: Verification by Google

As a security measure, every request sent by Google is signed and verified
against your partner key. You must also set the environment variable
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sources/inbox-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ import MessagesSend from '../api/endpoints/messages-send.mdx';
## Send and receive messages with the Inbox UI

Now that you connected this source to your instance and started a conversation,
you can see the conversations, messages, and templates in the [Airy Inbox](/apps/ui/inbox),
you can see the conversations, messages, and templates in the [Airy Inbox](/ui/inbox),
and use it to respond to the messages.

<ButtonBox
icon={() => <InboxSVG />}
title="Inbox"
description="Receive messages from different sources and send messages using the Inbox UI"
link="apps/ui/inbox"
link="ui/inbox"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ link='https://github.com/airyhq/components.'

**Sample Button Component**

<img alt="Button Template Example" src={useBaseUrl('img/apps/ui/storybookExample.png')} />
<img alt="Button Template Example" src={useBaseUrl('img/ui/storybookExample.png')} />
8 changes: 4 additions & 4 deletions docs/docs/apps/ui/inbox.md → docs/docs/ui/inbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Airy’s Inbox supports all templates that Facebook supports, from [Generic Temp

**Sample Button Template Message**

<img alt="Button Template Example" src={useBaseUrl('img/apps/ui/FacebookButtonTemplate.png')} />
<img alt="Button Template Example" src={useBaseUrl('img/ui/FacebookButtonTemplate.png')} />

**Sample request**

Expand Down Expand Up @@ -127,7 +127,7 @@ link='sources/chatplugin/overview'

**Sample RichCard Carousel Message**

<img alt="Rich Card Carousel Example" src={useBaseUrl('img/apps/ui/RichCardCarousel.gif')} />
<img alt="Rich Card Carousel Example" src={useBaseUrl('img/ui/RichCardCarousel.gif')} />

**Sample request**

Expand Down Expand Up @@ -200,7 +200,7 @@ The inbox enables you to search by:
icon={<PriceTag />}
title='Tags'
description='Tag your conversations for easy filtering, searching & segmenting'
link='apps/ui/tags'
link='ui/tags'
/>
<br/>

Expand All @@ -215,4 +215,4 @@ The inbox can filter by:
- Sources
- Tags

<img alt="Filter Inbox" src={useBaseUrl('img/apps/ui/FilteringInbox.gif')} />
<img alt="Filter Inbox" src={useBaseUrl('img/ui/FilteringInbox.gif')} />
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,27 @@ Additional features like [Filters, Search](inbox) and [Tags](tags) help you.
iconInvertible={true}
title='UI Quickstart'
description='Step by Step Guide on getting up and running with the UI'
link='apps/ui/quickstart'
link='ui/quickstart'
/>
<ButtonBox
icon={<DesktopComputerSVG />}
iconInvertible={true}
title='Inbox'
description='One inbox to see all your conversations & respond to them'
link='apps/ui/inbox'
link='ui/inbox'
/>
<ButtonBox
icon={<LabelSVG />}
iconInvertible={true}
title='Tags'
description='Tag your conversations for easy filtering, searching & segmenting'
link='apps/ui/tags'
link='ui/tags'
/>
<ButtonBox
icon={<ComponentsSVG />}
iconInvertible={true}
title='UI Components'
description='Buttons, Inputs, Loaders and all Airy UI Components '
link='apps/ui/components'
link='ui/components'
/>
</ButtonBoxList>
15 changes: 6 additions & 9 deletions docs/docs/apps/ui/quickstart.md → docs/docs/ui/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,14 @@ in to the UI**

</TLDR>

- [Introduction](#introduction)
The easiest way to see the Airy Core UI in action is to launch the [minikube
provider](getting-started/installation/minikube.md) and then follow these three
steps:

- [Step 1: Registration](#step-1-registration)
- [Step 2: Open the UI](#step-2-open-the-ui)
- [Step 3: Login](#step-3-login)

## Introduction

The easiest way to see the Airy Core UI in action is to launch the [minikube
provider](getting-started/installation/minikube.md) and then follow these three
steps.

## Step 1: Registration

To register a new user in the Airy Core you can use the **users.signup**
Expand Down Expand Up @@ -58,7 +55,7 @@ airy ui

Now enter your credentials on the login page and click **Login**.

<img alt="login" src={useBaseUrl('img/apps/ui/login.gif')} />
<img alt="login" src={useBaseUrl('img/ui/login.gif')} />

<SuccessBox>

Expand All @@ -75,5 +72,5 @@ icon={<PrototypeSVG />}
iconInvertible={true}
title='Next Step: Discover the Inbox'
description='Now that you can access the UI it is time to discover the Inbox and its features '
link='apps/ui/inbox'
link='ui/inbox'
/>
8 changes: 4 additions & 4 deletions docs/docs/apps/ui/tags.md → docs/docs/ui/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ Here are the ways you can create and use tags:
- Your users can create them manually directly in conversations
- They can be created in the Tag Manager

## Create Tags
## Create

When you create a tag you can choose a color to visually identify it better in the inbox.
This can also be done via the [Create Tags API](api/endpoints/tags.md#create).

<img alt="Demo Tags"src={useBaseUrl('img/apps/ui/create_tags.gif')} />
<img alt="Demo Tags"src={useBaseUrl('img/ui/create_tags.gif')} />

## Edit Tags
## Edit

When editing tags you can change the name and the color of each tag.
This can also be done via the [Edit Tags API](api/endpoints/tags.md#update).

## Delete Tags
## Delete

Deleting tags deletes them completely.
This can also be done via the [Delete Tags API](api/endpoints/tags.md#delete).
6 changes: 3 additions & 3 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module.exports = {
'getting-started/introduction',
'getting-started/components',
{
Installation: [
'Setup & Deployment': [
'getting-started/installation/introduction',
'getting-started/installation/minikube',
'getting-started/installation/production',
Expand All @@ -27,8 +27,8 @@ module.exports = {
'Airy Live Chat Plugin': [
'sources/chatplugin/overview',
'sources/chatplugin/demo',
'sources/chatplugin/quickstart',
'sources/chatplugin/installation',
'sources/chatplugin/quickstart',
'sources/chatplugin/customization',
],
},
Expand Down Expand Up @@ -60,7 +60,7 @@ module.exports = {
],
},
{
'💎 UI': ['apps/ui/introduction', 'apps/ui/quickstart', 'apps/ui/inbox', 'apps/ui/tags', 'apps/ui/components'],
'💎 UI': ['ui/introduction', 'ui/quickstart', 'ui/inbox', 'ui/tags', 'ui/components'],
},
{
'🛠️ Integrations': [
Expand Down
File renamed without changes