Conflict resolution (#470)

* DC-347 (#416) * Added forward slash to every redirect from Top and Navbar. (DC-307) (#422) * DC-307 * added forward slash for every slug of the file * DC-349 (#424) * Fix redirects. (#425) * Fix redirects (#426) * Fix redirects. * Fix staging build. * Fixes moesif issue (#427) * DC-88 (#415) * DC-88 * Update reference.md * DC-183 (#423) * DC-286 Added snippet for stopping connection in sample (#406) * change for exp branch * merge-docs-v1 added for build to workflow * changes for dev and prod dispatch events * Testing changes * DC-286 Added snippet for stopping connection in sample Co-authored-by: harshad-symbl <[email protected]> Co-authored-by: Adam Voliva <[email protected]> Co-authored-by: amritesh-singh <[email protected]> * Enable all trackers (#436) * DC-357 Adds enable all trackers + splits docs into logical buckets * added more content * Adds more changes * Updated/Added slugs for every Page required (DC-307) (#439) * DC-307 * added forward slash for every slug of the file * '/' added to slug of changelog for topbar * Added slugs for pages on sidebar of landing page * slugs for links on sidebars for API reference * slugs for links on sidebars for Tutorials, No Updates for SDKs * Adds changes to Labs topics + updates changelog Co-authored-by: pema-s <[email protected]> * DC-127 (#432) * DC-209 Consolidated two trackers with streaming api tutorials (#429) * DC-209 Consolidated two trackers with streaming api tutorials * removed trailing white-space * DC-225 Further explanation for the `score` and `definitive` parameters (#431) * DC-225 Further explanation for the and parameters * Improved wording * Revert "Updated/Added slugs for every Page required (DC-307) (#439)" (#441) This reverts commit 5fd0dde. * DC 356 implement the title tags for seo (#435) * DC-356 * DC-356 * DC-356 Co-authored-by: Pema <[email protected]> * Adds changes to Tracker Tutorials (#444) * fix: build errors due to #439 , resolved. (#445) * slugs added/updated as per DC-307 * updated id from `text-summary-ui` to `summary-ui` * removed redirects, due to using urls for the same version, causing build errors * Some incorrect changes with the last commit resolved * DC-358 (#447) * Added the styleguide and moved readme, CoC (#446) * Adds authentication info (#448) * DC-149 (#419) * DC-149 * DC-149 * Add logos to sdk (#452) * DC-360 * DC-360 * Update README.md (#326) * fix: TopBar highlighting bug fixed, hardcoded the slugs. (#449) * Updated the default routing for all the topbar links * fix: Active highlighting bug fixed, by hardcoding the slugs on regex * Handled for `/async-api/introduction` and `/async-api/reference` * corrects missing pages * change made on the stagging config for active links Co-authored-by: pema-s <[email protected]> * Corrects grammar (#453) * DC-377 (#458) * Update homepage cards (#459) * update ui cards * Makes dark mode default Co-authored-by: Kush Vora <[email protected]> * DC-380 (#460) * DC-365 (#462) * DC-361 (#456) * DC-358 * DC-361 * Revert "DC-361" This reverts commit 06086ab. * DC-361 * DC-361 * DC-381, DC-382 (#465) Adds bug fixes * Bug fixes 04 04 (#466) * DC-381, DC-382 Adds bug fixes * DC-129, DC-372 Co-authored-by: Amritesh Singh <[email protected]> Co-authored-by: harshal kaigaonkar <[email protected]> Co-authored-by: Adam Voliva <[email protected]> Co-authored-by: Mukulika <[email protected]> Co-authored-by: harshad-symbl <[email protected]> Co-authored-by: Kush Vora <[email protected]>
symblai · Apr 4, 2022 · b358005 · b358005
1 parent 01ba106
commit b358005
Show file tree

Hide file tree

Showing 59 changed files with 125 additions and 76 deletions.
diff --git a/docs/async-api/code-snippets/how-to-use-sentiment-analysis.md b/docs/async-api/code-snippets/how-to-use-sentiment-analysis.md
@@ -23,11 +23,10 @@ You must wait for the job to complete processing before you proceed with getting
 
 While we provide you with a default video URL for the API to process, which can be downloaded [here](https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4), you can replace that with any other video URL.
 
-### Request Example
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
-:::info
-Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
+### Request Example
 
 <Tabs
   defaultValue="cURL"

diff --git a/docs/async-api/code-snippets/receive-conversation-analytics.md b/docs/async-api/code-snippets/receive-conversation-analytics.md
@@ -19,11 +19,10 @@ While we provide you with a default video URL for the API to process, which can
 You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
 :::
 
-### Request Example
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
-:::info
-Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
+### Request Example
 
 <Tabs
   defaultValue="cURL"

diff --git a/docs/async-api/code-snippets/receive-entities.md b/docs/async-api/code-snippets/receive-entities.md
@@ -19,11 +19,10 @@ While we provide you with a default video URL for the API to process, which can
 You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
 :::
 
-### Request Example
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
-:::info
-Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
+### Request Example
 
 <Tabs
   defaultValue="cURL"

diff --git a/docs/async-api/code-snippets/receive-speech-to-text-and-ai-insights.md b/docs/async-api/code-snippets/receive-speech-to-text-and-ai-insights.md
@@ -21,11 +21,10 @@ While we provide you with a default video URL for the API to process, which can
 You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
 :::
 
-### Request Example
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
-:::info
-Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
+### Request Example
 
 <Tabs
   defaultValue="cURL"

diff --git a/docs/async-api/code-snippets/sentiment-analysis-on-messages.md b/docs/async-api/code-snippets/sentiment-analysis-on-messages.md
@@ -36,6 +36,9 @@ In this example, we will process an audio file (in .wav format) via Async Audio
 
 To view the complete reference, see [Async API documentation](/docs/async-api/introduction). 
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### Example API Endpoint
 
 `POST https://api.symbl.ai/v1/process/audio`

diff --git a/docs/async-api/code-snippets/sentiment-analysis-on-topics.md b/docs/async-api/code-snippets/sentiment-analysis-on-topics.md
@@ -34,6 +34,9 @@ In this example, we will process an audio file (in .wav format) via Async Audio
 
 To view the complete reference, see [Async API documentation](/docs/async-api/introduction). 
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### Example API Endpoint
 
 `POST https://api.symbl.ai/v1/process/audio`

diff --git a/docs/async-api/code-snippets/track-phrases-in-a-conversation.md b/docs/async-api/code-snippets/track-phrases-in-a-conversation.md
@@ -23,11 +23,10 @@ While we provide you with a default textual conversation for the API to process
 You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
 :::
 
-### Request Example
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
-:::info
-Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
+### Request Example
 
 <Tabs
   defaultValue="cURL"

diff --git a/docs/async-api/introduction.md b/docs/async-api/introduction.md
@@ -4,6 +4,7 @@ title: Async API
 description: Symbl.ai Async APIs provides a REST interface for submitting any recorded or saved conversations for transcription. Check out our Async APIs documentation to get started.
 sidebar_label: Introduction
 slug: /async-api/introduction/
+pagination_label: Async API
 ---
 
 <head>

diff --git a/docs/async-api/overview/audio/post-audio-url.md b/docs/async-api/overview/audio/post-audio-url.md
@@ -18,15 +18,16 @@ It can be utilized for any use case where you have access to recorded audio stor
 The URL provided must be a publicly available URL. Currently, we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 
 `POST https://api.symbl.ai/v1/process/audio/url`
 
 
 ### Example API Call
 
-Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/audio/post-audio.md b/docs/async-api/overview/audio/post-audio.md
@@ -15,6 +15,9 @@ It can be utilized for any use case where you have access to recorded audio and
 
 Use this API to upload your file and generate a Conversation ID. If you want to append additional audio information to the same Conversation ID.
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 
 `POST https://api.symbl.ai/v1/process/audio`
@@ -23,8 +26,6 @@ Use this API to upload your file and generate a Conversation ID. If you want to
 
 The sample request accepts just the raw audio file from the data with the MIME typeset in the Content-Type Header. The audio file should only have Mono Channel.
 
-Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/audio/put-audio-url.md b/docs/async-api/overview/audio/put-audio-url.md
@@ -18,16 +18,15 @@ If there are multiple requests are submitted for the same Conversation ID, all t
 in order to maintain the order of the requests for the conversation.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
 ### API Endpoint
 
 `PUT https://api.symbl.ai/v1/process/audio/url/:conversationId`
 
-
 ### Example API Call
 
-Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/audio/put-audio.md b/docs/async-api/overview/audio/put-audio.md
@@ -13,15 +13,15 @@ The Async Audio API allows you to process an additional audio file to the previo
 
 It can be useful in any use case where you have access to multiple audio files of any type of conversation, and you want to extract the insightful items supported by the [Conversation API](/docs/conversation-api/introduction).
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
 ### API Endpoint
 
 `PUT https://api.symbl.ai/v1/process/audio/:conversationId`
 
 ### Example API Call
 
-Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/text/post-text.md b/docs/async-api/overview/text/post-text.md
@@ -11,14 +11,15 @@ import TabItem from '@theme/TabItem';
 
 The Async Text API allows you to process any text payload. This API is useful for when you want to extract Conversation Insights from textual content.
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 
 `POST https://api.symbl.ai/v1/process/text`
 
 ### Example API Call
 
-Before using the Async Text API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/text/put-text.md b/docs/async-api/overview/text/put-text.md
@@ -16,15 +16,15 @@ It can be useful in cases where you have new information like chats, emails or m
 If there are multiple requests are submitted for the same Conversation ID, all the requests will be processed synchronously in order to maintain the order of the requests for the conversation.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 
 `PUT https://api.symbl.ai/v1/process/text/:conversationId`
 
 ### Example API Call
 
-Before using the Async Text API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/video/post-video-url.md b/docs/async-api/overview/video/post-video-url.md
@@ -21,16 +21,15 @@ The URL provided must be a publicly available URL. Currently we do not support a
 This API supports only <b>mp4</b> file formats video. If you have any other type of file, you need to first convert the file to the supported format in order to use the API.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
 ### API Endpoint
 
 `POST https://api.symbl.ai/v1/process/video/url`
 
-
 ### Example API Call
 
-Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/video/post-video.md b/docs/async-api/overview/video/post-video.md
@@ -17,14 +17,14 @@ It can be useful in any use case where you have access to the video file of any
 This API supports only <b>mp4</b> file formats. If you have any other type of file, you need to first convert the file to the supported format in order to use the API.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 `POST https://api.symbl.ai/v1/process/video`
 
-
 ### Example API Call
 
-Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/video/put-video-url.md b/docs/async-api/overview/video/put-video-url.md
@@ -22,14 +22,15 @@ If there are multiple requests are submitted for the same Conversation ID all th
 in order to maintain the order of the requests for the conversation.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 
 `PUT https://api.symbl.ai/v1/process/video/url/:conversationId`
 
 ### Example API Call
 
-Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/overview/video/put-video.md b/docs/async-api/overview/video/put-video.md
@@ -22,16 +22,15 @@ If there are multiple requests are submitted for the same Conversation ID, all t
 in order to maintain the order of the requests for the conversation.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 ### API Endpoint
 
 `PUT https://api.symbl.ai/v1/process/video/:conversationId`
 
 ### Example API Call
 
-:::info
-Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[

diff --git a/docs/async-api/tutorials/generate-pre-built-ui-from-video-recordings.md b/docs/async-api/tutorials/generate-pre-built-ui-from-video-recordings.md
@@ -39,12 +39,10 @@ To get the Summary UI, we need to process the video using Symbl's [POST Video Us
 You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
 :::
 
-### Example API Call
-
-:::info
-Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
-:::
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
 
+### Example API Call
 
 <Tabs
   defaultValue="cURL"

diff --git a/docs/async-api/tutorials/get-speaker-separation-audio-video.md b/docs/async-api/tutorials/get-speaker-separation-audio-video.md
@@ -47,15 +47,16 @@ This snippet shows a cURL command for consuming the Async Video URL-based API wh
 The below example uses the Async Video URL API, but Speaker Separation can be achieved with other Async Audio/Video APIs in the same way.
 :::
 
-* `AUTH_TOKEN` needs to be replaced with the Bearer token generated during [our authentication process](/docs/developer-tools/authentication).
-
-* For accuracy, `NUMBER_OF_UNIQUE_SPEAKERS` should match the number of unique speakers in the Audio/Video data.
+For accuracy, `NUMBER_OF_UNIQUE_SPEAKERS` should match the number of unique speakers in the Audio/Video data.
 
 
 :::caution
 You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
 :::
 
+### Authentication
+Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.
+
 #### Code Example
 
 <Tabs

diff --git a/docs/conversation-api/concepts/action-items.md b/docs/conversation-api/concepts/action-items.md
@@ -3,6 +3,7 @@ id: action-items
 title: Action Items
 sidebar_label: Action Items
 slug: /concepts/action-items/
+pagination_label: Action Items
 ---
 
 import Tabs from '@theme/Tabs';

diff --git a/docs/conversation-api/concepts/analytics.md b/docs/conversation-api/concepts/analytics.md
@@ -3,6 +3,7 @@ id: analytics
 title: Conversational Analytics
 sidebar_label: Introduction
 slug: /concepts/conversational-analytics/
+pagination_label: Conversation Analytics
 ---
 
 import Tabs from '@theme/Tabs';

diff --git a/docs/conversation-api/concepts/comprehensive-action-items.md b/docs/conversation-api/concepts/comprehensive-action-items.md
@@ -2,6 +2,7 @@
 id: comprehensive-action-items
 title: Comprehensive Action Items (Labs)
 sidebar_label: Introduction
+pagination_label: Comprehensive Action Items
 slug: /concepts/comprehensive-action-items/
 ---
 

diff --git a/docs/conversation-api/concepts/conversation-groups.md b/docs/conversation-api/concepts/conversation-groups.md
@@ -2,6 +2,7 @@
 id: conversation-groups
 title: Conversation Groups (Beta)
 sidebar_label: Introduction
+pagination_label: Conversation Groups
 slug: /concepts/conversation-groups/
 ---
 

diff --git a/docs/conversation-api/concepts/follow-ups.md b/docs/conversation-api/concepts/follow-ups.md
@@ -3,6 +3,7 @@ id: follow-ups
 title:  Follow Ups
 sidebar_label:  Follow Ups
 slug: /concepts/follow-ups/
+pagination_label: Follow Ups
 ---
 
 import Tabs from '@theme/Tabs';

diff --git a/docs/conversation-api/concepts/questions.md b/docs/conversation-api/concepts/questions.md
@@ -3,6 +3,7 @@ id: questions
 title: Questions
 sidebar_label: Introduction
 slug: /concepts/questions/
+pagination_label: Questions
 ---
 
 import Tabs from '@theme/Tabs';

diff --git a/docs/conversation-api/concepts/redacting-pii.md b/docs/conversation-api/concepts/redacting-pii.md
@@ -3,6 +3,7 @@ id: redaction-pii
 title: Identifying and Redacting PII and PCI Data
 sidebar_label: PII and PCI Identification and Redaction 
 slug: /concepts/redaction-pii/
+pagination_label: PII and PCI Identification and Redaction
 ---
 
 import Tabs from '@theme/Tabs';

diff --git a/docs/conversation-api/concepts/sentiment.md b/docs/conversation-api/concepts/sentiment.md
@@ -4,6 +4,7 @@ title: Sentiment Analysis (Beta)
 sidebar_label: Introduction
 description: Sentiment API enables developers to detect positive or negative sentiment from conversations in real-time. Learn more.
 slug: /concepts/sentiment-analysis/
+pagination_label: Sentiment Analysis
 ---
 
 <head>

diff --git a/docs/conversation-api/concepts/speech-to-text.md b/docs/conversation-api/concepts/speech-to-text.md
@@ -4,6 +4,7 @@ title: Speech-to-Text
 description: Get real-time speech-to-text data and analytics from your conversations with Symbl.ai APIs. Learn more.
 sidebar_label: Introduction
 slug: /concepts/speech-to-text/
+pagination_label: Speech-to-text
 ---
 
 <head>