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

Aherman3 getting started videos #1537

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 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
2 changes: 1 addition & 1 deletion docusaurus/docs/getting-started-with-wechaty.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Google cloud shell is also an online development and operations environment whic

## Local development environment

You can also set up your own server for running the [getting-started repository](https://github.com/wechaty/wechaty-getting-started) on your machine instead of using the cloud-based IDE. There is a [beginner-friendly tutorial](getting-started/running-locally.mdx) in the [tutorials section](getting-started/overview.mdx) which will take you by the hand to help you run the getting-started repository on your local machine.
You can also set up your own server for running the [getting-started repository](https://github.com/wechaty/wechaty-getting-started) on your machine instead of using the cloud-based IDE. There is a [beginner-friendly tutorial](getting-started/running-locally.mdx) in the [tutorials section](getting-started/overview.md) which will take you by the hand to help you run the getting-started repository on your local machine.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import ServiceBadges from '../puppet-services/transclusions/badges.mdx'

<!-- Pushes a curious reader through the first few minutes of use. -->

If you are a total beginner to Wechaty, start from this section.
If you are a total beginner to Wechaty, start from this section.

You can run Wechaty on following platforms:

Expand All @@ -21,13 +21,19 @@ You can run Wechaty on following platforms:

Wechaty is a RPA (Robotic Process Automation) SDK for Chatbot Makers which can help you create a bot in 6 lines of [JavaScript](https://GitHub.com/Wechaty/wechaty), [Python](https://GitHub.com/Wechaty/python-wechaty/), [Go](https://GitHub.com/Wechaty/go-wechaty/), and [Java](https://GitHub.com/Wechaty/java-wechaty/), with cross-platform support including [Linux, Windows, MacOS](https://github.com/wechaty/wechaty/actions?query=workflow%3ANPM), and [Docker](https://github.com/wechaty/wechaty/actions?query=workflow%3ADocker).

You will learn the following fundamental features of Wechaty in the getting-started tutorials:
You can also watch the [video series](https://www.youtube.com/watch?v=cZd42xxaTcI&list=PLkLKftrhFi7vfaADtPrGyuutbpcA_ppxE) below to get an introduction and demonstration of some of the capabilities and applications using Wechaty's getting-started repository.

- Turn different instant messaging (IM) systems (such as WeChat, Wecom,Whatsapp, Lark,Gitter, and TikTok) account into chatbot.
- Use the chatbot to communicate or do anything on behalf of you.
[![Getting Started Video Tutorial Series](../../static/img/getting-started-video-tutorials.webp)](https://www.youtube.com/watch?v=cZd42xxaTcI&list=PLkLKftrhFi7vfaADtPrGyuutbpcA_ppxE)

In the getting-started tutorials, you will learn the following fundamental features of Wechaty:

- Turn different instant messaging (IM) systems (such as WeChat, WeCom,Whatsapp, Lark,Gitter, and TikTok) accounts into chatbots.
- Work out of the box on Linux, Mac and Windows.
- Supports all [puppets](../puppet-services/overview.mdx) like Wechat, WhatsApp, WeCom, Lark and so on.
- Supports all [puppets](../puppet-services/overview.mdx) like WeChat, WhatsApp, WeCom, Lark and so on.
- Reply with a `dong` message when it recieves a `ding` message.
- Receive and accept friendship requests.
- Create group chats and add/remove users.
- Send files, URLs, and contact cards.

:::note RPA for Instant Messaging Software

Expand Down
10 changes: 5 additions & 5 deletions docusaurus/docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This section is a high-level overview of how the Wechaty Documentation is struct
The Wechaty Documentation covers everything you need to know about Wechaty. It comprises of five broad sections and these sections are:

- [Introduction section](/overview.mdx)
- [Tutorials section](getting-started/overview.mdx)
- [Tutorials section](getting-started/overview.md)
- [How to Guides section](howto/overview.mdx)
- [References section](references/overview.mdx)
- [Explanations section](explanations/overview.mdx)
Expand All @@ -35,7 +35,7 @@ The Introduction section provides an in-depth introduction to Wechaty, Wechaty c
- [Contributing to Wechaty](/contributing/overview.md)
- [Changelog](/changelog.md)

## [Tutorials](getting-started/overview.mdx)
## [Tutorials](getting-started/overview.md)

> Note: If you are an absolute beginner, we recommend you to start with the [Introduction](/overview.mdx) to familiarize yourself with Wechaty, Wechaty community, and the Wechaty ecosystem

Expand All @@ -44,7 +44,7 @@ This is a learning-oriented section which consists of two levels of tutorials:
- Beginner tutorials
- Advanced tutorials

**[Beginner tutorials](getting-started/overview.mdx)**
**[Beginner tutorials](getting-started/overview.md)**

The beginner tutorials will take you by the hand and teach you how to build a Chatbot application from scratch through a series of steps. Familiarity with [Wechaty](/) or Chatbot application development in general is not a prerequisite for you to complete the beginner tutorials.

Expand All @@ -55,7 +55,7 @@ The advanced tutorials require you to have at least intermediate to advanced kno

## [How to Guides](howto/overview.mdx)

This section comprises of guides that will take you through series of steps involved in addressing key problems and use-cases in Wechaty. It requires intermediate to advanced knowledge of how Wechaty works. If you are an absolute beginner, it is recommended you start from the [Introduction](/overview.mdx) and [Tutorials](getting-started/overview.mdx) sections before going to the [How to Guides](howto/overview.mdx).
This section comprises of guides that will take you through series of steps involved in addressing key problems and use-cases in Wechaty. It requires intermediate to advanced knowledge of how Wechaty works. If you are an absolute beginner, it is recommended you start from the [Introduction](/overview.mdx) and [Tutorials](getting-started/overview.md) sections before going to the [How to Guides](howto/overview.mdx).

## [Reference Guides](references/overview.mdx)

Expand All @@ -65,4 +65,4 @@ The Reference Guide contains technical references for Wechaty APIs and other asp

## [Explanations](explanations/overview.mdx)

The Explanation section discusses key topics and concepts at a fairly high level and provides useful explanations to expand your knowledge of Wechaty. It requires atleast basic to intermediate knowledge of Wechaty or Chatbot application development in general. If you are an absolute beginner, we recommend you start from the [Introduction](/overview.mdx) and [Tutorials](getting-started/overview.mdx) sections of the documentation.
The Explanation section discusses key topics and concepts at a fairly high level and provides useful explanations to expand your knowledge of Wechaty. It requires atleast basic to intermediate knowledge of Wechaty or Chatbot application development in general. If you are an absolute beginner, we recommend you start from the [Introduction](/overview.mdx) and [Tutorials](getting-started/overview.md) sections of the documentation.
4 changes: 2 additions & 2 deletions docusaurus/docs/tutorials/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ These tutorials take you by the hand through a series of steps to create a chatb

## Build your first chatbot with wechaty

If you are a total beginner to Wechaty or chatbot application development in general, we recommend you to start from the [Getting started](getting-started/overview.mdx) tutorials. In these tutorials you'll be building a **ding-dong bot** which replies with a `dong` message when it recieves a `ding` message.
If you are a total beginner to Wechaty or chatbot application development in general, we recommend you to start from the [Getting started](getting-started/overview.md) tutorials. In these tutorials you'll be building a **ding-dong bot** which replies with a `dong` message when it recieves a `ding` message.

The fastest way to get started with Wechaty is to use a Cloud based IDE for **running the bot**. To understand how it works, You can either use:

- [Gitpod](quick-start/running-on-gitpod.md)
- [Google Cloud Shell](quick-start/running-on-google-cloud-shell.md)

If you are a total begginer then we recommend using [Gitpod](https://gitpod.io/#https://github.com/wechaty/wechaty-getting-started).
If you are a total beginner then we recommend using [Gitpod](https://gitpod.io/#https://github.com/wechaty/wechaty-getting-started).

Once you get basic idea of ding-dong bot, you can try out building it from scratch by following our [Running Locally](getting-started/running-locally.mdx) tutorial.
aherman3 marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Binary file not shown.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "wechaty-docusaurus",
"version": "0.11.7",
"version": "0.11.8",
"description": "Wechaty Official Website for Documentations",
"private": true,
"type": "module",
Expand Down Expand Up @@ -64,6 +64,7 @@
"npm-run-all": "^4.1.5",
"probe-image-size": "^7.2.3",
"tls": "^0.0.1",
"ts-node": "^10.9.2",
aherman3 marked this conversation as resolved.
Show resolved Hide resolved
"tstest": "^1.2.8",
"typescript": "^4.6.3",
"uuid": "^8.3.2",
Expand Down
Loading