From b96c5bdb03ac45b48725b88858b908510818b55e Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Tue, 1 Jun 2021 11:35:34 +0300 Subject: [PATCH 1/9] Add overview subsection of the explanation section --- docusaurus/docs/explainations/overview.mdx | 28 +++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docusaurus/docs/explainations/overview.mdx b/docusaurus/docs/explainations/overview.mdx index 67ac353bd9b..65a091432a4 100644 --- a/docusaurus/docs/explainations/overview.mdx +++ b/docusaurus/docs/explainations/overview.mdx @@ -1,7 +1,29 @@ --- slug: /explainations/ -title: Wechaty explainations overview -sidebar_label: 'Explainations: Overview' +title: Overview of Explanation section +sidebar_label: 'Overview of Explanation section' --- -Explanations will discuss key topics and concepts at a fairly high level and provide useful background information and explanation. +![Wechaty: Conversational RPA SDK for Chatbot Makers](/img/wechaty-logo.svg) + +The **Explanation section** discusses topics that broaden your knowledge of Wechaty. Non-technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. + +## [Life cycle](#placeholder-link) + +In this section, you will understand the different phases of the chatbot development life cycle. A concise explanation on what is happening with your chatbot will also help you understand the importance of each phase. + +## [Architecture](#placeholder-link) + +The Architecture section disusses the fundamental structures of a chatbot. You will learn how the chatbot works and interacts with other components, how each of the component is represented, and how it all affects the chatbot as a whole. + +## [Testing](#placeholder-link) + +The Testing section shows how a chatbot is being tested in each phase. You will learn more about the most common bugs and defects that most users encounter while using Wechaty. Other types of issues are also discussed here, including the types of actions and expected output or solutions. + +## [SDK](#placeholder-link) + +In this section, you will gain an understanding of Wechaty as a conversational robotic process automation SDK and will also learn about its key benefits as the chosen SDK for Wechaty chatbots. + +## [Troubleshooting](#placeholder-link) + +The Troubleshooting section discusses the most common problems that you will encounter while using Wechaty to create customized chatbots. From d3e913c12a9861bee9cde7a274516513e814e94c Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Thu, 8 Jul 2021 11:53:04 +0300 Subject: [PATCH 2/9] Fix typos identified by @Rohitesh-Kumar-Jain --- docusaurus/docs/explainations/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus/docs/explainations/overview.mdx b/docusaurus/docs/explainations/overview.mdx index 65a091432a4..dc8d0e9d9ed 100644 --- a/docusaurus/docs/explainations/overview.mdx +++ b/docusaurus/docs/explainations/overview.mdx @@ -14,7 +14,7 @@ In this section, you will understand the different phases of the chatbot develop ## [Architecture](#placeholder-link) -The Architecture section disusses the fundamental structures of a chatbot. You will learn how the chatbot works and interacts with other components, how each of the component is represented, and how it all affects the chatbot as a whole. +The Architecture section discusses the fundamental structures of a chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all affects the chatbot as a whole. ## [Testing](#placeholder-link) From d56295dfc9f8f590f973e950f9cdb8e0e7c58433 Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Wed, 21 Jul 2021 16:15:34 +0300 Subject: [PATCH 3/9] Did some editing --- docusaurus/docs/explainations/overview.mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docusaurus/docs/explainations/overview.mdx b/docusaurus/docs/explainations/overview.mdx index dc8d0e9d9ed..af670dc316d 100644 --- a/docusaurus/docs/explainations/overview.mdx +++ b/docusaurus/docs/explainations/overview.mdx @@ -4,13 +4,11 @@ title: Overview of Explanation section sidebar_label: 'Overview of Explanation section' --- -![Wechaty: Conversational RPA SDK for Chatbot Makers](/img/wechaty-logo.svg) - -The **Explanation section** discusses topics that broaden your knowledge of Wechaty. Non-technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. +The **Explanation section** discusses topics that broaden your knowledge of Wechaty. Technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. ## [Life cycle](#placeholder-link) -In this section, you will understand the different phases of the chatbot development life cycle. A concise explanation on what is happening with your chatbot will also help you understand the importance of each phase. +In this section, you will understand the different phases of the Wechaty chatbot development life cycle. A concise explanation on what is happening with your chatbot will also help you understand the importance of each phase. ## [Architecture](#placeholder-link) @@ -18,7 +16,7 @@ The Architecture section discusses the fundamental structures of a chatbot. You ## [Testing](#placeholder-link) -The Testing section shows how a chatbot is being tested in each phase. You will learn more about the most common bugs and defects that most users encounter while using Wechaty. Other types of issues are also discussed here, including the types of actions and expected output or solutions. +The Testing section shows how you will go about testing a chatbot built using Wechaty. ## [SDK](#placeholder-link) @@ -26,4 +24,4 @@ In this section, you will gain an understanding of Wechaty as a conversational r ## [Troubleshooting](#placeholder-link) -The Troubleshooting section discusses the most common problems that you will encounter while using Wechaty to create customized chatbots. +The Troubleshooting section discusses the most common problems that you will encounter while using Wechaty to create chatbots and while contributing to Wechaty and the Wechaty documentation. From 04e1f69df5cb7fc3d870c0260fae69b35acf4f87 Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Sat, 4 Sep 2021 10:40:41 +0300 Subject: [PATCH 4/9] Edit overview to the explanation section --- docusaurus/docs/explainations/overview.mdx | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docusaurus/docs/explainations/overview.mdx b/docusaurus/docs/explainations/overview.mdx index af670dc316d..e5642175dea 100644 --- a/docusaurus/docs/explainations/overview.mdx +++ b/docusaurus/docs/explainations/overview.mdx @@ -6,22 +6,18 @@ sidebar_label: 'Overview of Explanation section' The **Explanation section** discusses topics that broaden your knowledge of Wechaty. Technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. -## [Life cycle](#placeholder-link) +## [Architecture](architecture.md) -In this section, you will understand the different phases of the Wechaty chatbot development life cycle. A concise explanation on what is happening with your chatbot will also help you understand the importance of each phase. +The Architecture section discusses the fundamental structures of Wechaty chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all fits as a whole. -## [Architecture](#placeholder-link) +## [Testing](testing.md) -The Architecture section discusses the fundamental structures of a chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all affects the chatbot as a whole. +The Testing section will highlight tools and frameworks you can use for testing Wechaty chatbots and chatbots in general. -## [Testing](#placeholder-link) +## [Software Development Kit(SDK)](#placeholder) -The Testing section shows how you will go about testing a chatbot built using Wechaty. +Wechaty is a modern conversational robotic process automation SDK for chatbot makers. In this section, you will gain an understanding of what a Software Development Kit is and why Wechaty should be your preferred SDK for making chatbots. -## [SDK](#placeholder-link) +## [Troubleshooting](troubleshooting.mdx) -In this section, you will gain an understanding of Wechaty as a conversational robotic process automation SDK and will also learn about its key benefits as the chosen SDK for Wechaty chatbots. - -## [Troubleshooting](#placeholder-link) - -The Troubleshooting section discusses the most common problems that you will encounter while using Wechaty to create chatbots and while contributing to Wechaty and the Wechaty documentation. +The Troubleshooting section discusses the most common problems that you will encounter while using Wechaty to create chatbots as well as contributing to Wechaty and the Wechaty documentation. From b53c3881cea70514a6fb41d0c98a6ca082d16d85 Mon Sep 17 00:00:00 2001 From: chris-4444 <82779784+chris-4444@users.noreply.github.com> Date: Thu, 9 Sep 2021 19:13:36 +0800 Subject: [PATCH 5/9] Update overview.mdx --- docusaurus/docs/explainations/overview.mdx | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docusaurus/docs/explainations/overview.mdx b/docusaurus/docs/explainations/overview.mdx index e5642175dea..b3ffc88327e 100644 --- a/docusaurus/docs/explainations/overview.mdx +++ b/docusaurus/docs/explainations/overview.mdx @@ -4,19 +4,24 @@ title: Overview of Explanation section sidebar_label: 'Overview of Explanation section' --- -The **Explanation section** discusses topics that broaden your knowledge of Wechaty. Technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. +The **Explanation** section discusses topics that broaden your knowledge of Wechaty. Technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. ## [Architecture](architecture.md) -The Architecture section discusses the fundamental structures of Wechaty chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all fits as a whole. +The **Architecture** section discusses the fundamental structures of Wechaty chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all fits as a whole. ## [Testing](testing.md) -The Testing section will highlight tools and frameworks you can use for testing Wechaty chatbots and chatbots in general. +The **Testing** section will highlight tools and frameworks you can use for testing Wechaty chatbots and chatbots in general. -## [Software Development Kit(SDK)](#placeholder) +## DevOps Tools -Wechaty is a modern conversational robotic process automation SDK for chatbot makers. In this section, you will gain an understanding of what a Software Development Kit is and why Wechaty should be your preferred SDK for making chatbots. +In this section, we learn about the **DevOps tools and configurations** used by Wechaty while creating chatbots, puppets and certain workflows. + + +## [Software Development Kit(SDK), Robotic Process Automation (RPA), and Conversational Interfaces](#placeholder) + +Wechaty is a modern conversational robotic process automation SDK for chatbot makers. In this section, you will gain an understanding of what a **Software Development Kit** is and why Wechaty should be your preferred SDK for making chatbots. You will also learn about **RPA** and **conversational interfaces**. ## [Troubleshooting](troubleshooting.mdx) From 2fdc8ed68d74a441c85b1c195111342ed31a9bfd Mon Sep 17 00:00:00 2001 From: chris-4444 <82779784+chris-4444@users.noreply.github.com> Date: Tue, 14 Sep 2021 20:33:13 +0800 Subject: [PATCH 6/9] Update overview.mdx --- docusaurus/docs/explanations/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus/docs/explanations/overview.mdx b/docusaurus/docs/explanations/overview.mdx index 2c861cb31ea..7af28f8f57e 100644 --- a/docusaurus/docs/explanations/overview.mdx +++ b/docusaurus/docs/explanations/overview.mdx @@ -18,7 +18,7 @@ The **Testing** section will highlight tools and frameworks you can use for test In this section, we learn about the **DevOps tools and configurations** used by Wechaty while creating chatbots, puppets and certain workflows. -## [Software Development Kit(SDK), Robotic Process Automation (RPA), and Conversational Interfaces](#placeholder) +## SDK, RPA, and Conversational Interfaces Wechaty is a modern conversational robotic process automation SDK for chatbot makers. In this section, you will gain an understanding of what a **Software Development Kit** is and why Wechaty should be your preferred SDK for making chatbots. You will also learn about **RPA** and **conversational interfaces**. From ae6fb07389de74e880d20055d90e5de8b82bc244 Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Tue, 14 Sep 2021 17:40:36 +0300 Subject: [PATCH 7/9] Change spelling and include all sections in Explanation section to overview --- docusaurus/docs/explanations/overview.mdx | 42 +++++++++++++++++++++-- docusaurus/docusaurus.config.js | 2 +- docusaurus/sidebars.ts | 2 +- 3 files changed, 41 insertions(+), 5 deletions(-) diff --git a/docusaurus/docs/explanations/overview.mdx b/docusaurus/docs/explanations/overview.mdx index 7af28f8f57e..d56d2efea60 100644 --- a/docusaurus/docs/explanations/overview.mdx +++ b/docusaurus/docs/explanations/overview.mdx @@ -1,20 +1,52 @@ --- slug: /explanations/ -title: Overview of Explanation section -sidebar_label: "Overview of Explanation section" +title: Overview +sidebar_label: "Overview" --- The **Explanation** section discusses topics that broaden your knowledge of Wechaty. Technical facts and some tidbits of useful information are found here to give you more clarity and understanding of what Wechaty is all about. +## [Converstional](conversational.md) + +TBW + +## [RPA](rpa.md) + +TBW + +## [Motivation](motivation.md) + +TBW + +## [Concepts](concepts.md) + +TBW + ## [Architecture](architecture.md) The **Architecture** section discusses the fundamental structures of Wechaty chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all fits as a whole. +## [Life cycle](lifecycle.md) + +TBW + +## [Alternatives](alternatives.md) + +TBW + +## [Glossary](glossary.md) + +TBW + ## [Testing](testing.md) The **Testing** section will highlight tools and frameworks you can use for testing Wechaty chatbots and chatbots in general. -## DevOps Tools +## [FAQ](faq.md) + +TBW + +## [DevOps Tools](#placeholder-link) In this section, we learn about the **DevOps tools and configurations** used by Wechaty while creating chatbots, puppets and certain workflows. @@ -25,3 +57,7 @@ Wechaty is a modern conversational robotic process automation SDK for chatbot ma ## [Troubleshooting](troubleshooting.mdx) The Troubleshooting section discusses the most common problems that you will encounter while using Wechaty to create chatbots as well as contributing to Wechaty and the Wechaty documentation. + +## [Docusaurus](docusaurus/doc1.md) + +TBW diff --git a/docusaurus/docusaurus.config.js b/docusaurus/docusaurus.config.js index 187dc441dd4..bb1c801af2e 100644 --- a/docusaurus/docusaurus.config.js +++ b/docusaurus/docusaurus.config.js @@ -47,7 +47,7 @@ const config = { { label: 'Tutorials', to: 'docs/tutorials/' }, { label: 'How-to Guides', to: 'docs/howto/' }, { label: 'References', to: 'docs/references/' }, - { label: 'explanations', to: 'docs/explanations/' }, + { label: 'Explanations', to: 'docs/explanations/' }, ], }, { label: 'GitHub', href: 'https://github.com/wechaty/wechaty#readme', position: 'right' }, diff --git a/docusaurus/sidebars.ts b/docusaurus/sidebars.ts index df5366c2a30..5330a469901 100644 --- a/docusaurus/sidebars.ts +++ b/docusaurus/sidebars.ts @@ -325,7 +325,7 @@ const references = { } const explanations = { - label: 'explanations', + label: 'Explanations', items: [ 'explanations/overview', 'explanations/conversational', From f4e2bbaffaa0e2a14093e6e504ebf0ca013eaff1 Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Tue, 14 Sep 2021 18:49:06 +0300 Subject: [PATCH 8/9] Fix incorrect link --- docusaurus/docs/explanations/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus/docs/explanations/overview.mdx b/docusaurus/docs/explanations/overview.mdx index d56d2efea60..ccc821d8498 100644 --- a/docusaurus/docs/explanations/overview.mdx +++ b/docusaurus/docs/explanations/overview.mdx @@ -14,7 +14,7 @@ TBW TBW -## [Motivation](motivation.md) +## [Motivation](motivations.md) TBW From 81d5963ee505052ed32c6ec2f5cee5a9a6b93cf4 Mon Sep 17 00:00:00 2001 From: nibble0101 Date: Wed, 15 Sep 2021 21:31:37 +0300 Subject: [PATCH 9/9] Capitalize subheadings and add placeholder links --- docusaurus/docs/explanations/overview.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docusaurus/docs/explanations/overview.mdx b/docusaurus/docs/explanations/overview.mdx index ccc821d8498..d2a62ac6ef5 100644 --- a/docusaurus/docs/explanations/overview.mdx +++ b/docusaurus/docs/explanations/overview.mdx @@ -26,7 +26,7 @@ TBW The **Architecture** section discusses the fundamental structures of Wechaty chatbot. You will learn how the chatbot works and interacts with other components, how each of the components is represented, and how it all fits as a whole. -## [Life cycle](lifecycle.md) +## [Life Cycle](lifecycle.md) TBW @@ -46,11 +46,11 @@ The **Testing** section will highlight tools and frameworks you can use for test TBW -## [DevOps Tools](#placeholder-link) +## [DevOps Toolset](#placeholder-link) In this section, we learn about the **DevOps tools and configurations** used by Wechaty while creating chatbots, puppets and certain workflows. -## SDK, RPA, and Conversational Interfaces +## [SDK & CUI](#placeholder-link) Wechaty is a modern conversational robotic process automation SDK for chatbot makers. In this section, you will gain an understanding of what a **Software Development Kit** is and why Wechaty should be your preferred SDK for making chatbots. You will also learn about **RPA** and **conversational interfaces**.