Getting started overview by shwetalsoni · Pull Request #935 · wechaty/docusaurus

shwetalsoni · 2021-06-10T11:57:50Z

shwetalsoni · 2021-06-10T11:58:27Z

This PR is renewed PR for #897.

shwetalsoni · 2021-06-10T12:01:32Z

sbis04 · 2021-06-12T03:50:05Z

+If you are a total beginner to Wechaty, start from this section. 
+
+You can run Wechaty on following platforms:
+* [Cloud IDE](getting-started/quick-start.mdx)


I have one little suggestion here, it would be nice to use Google Cloud Shell here instead of Cloud IDE as in the other pages of the docs we are referring it by this name.

yes seems legit

Rohitesh-Kumar-Jain · 2021-06-12T12:03:39Z

@shwetalsoni thanks for renewing the PR, PR looks good to me, Souvik suggested a valid point, pls do consider that.

proudofsimin

Please let me know if you have any question.

proudofsimin · 2021-06-13T14:09:30Z

+* With just a few lines of code, your WeChat/Whatsapp account will be turned into a chatbot, a.k.a [Conversational User Interface](https://en.wikipedia.org/wiki/Conversational_user_interface) Automation Software. 
+
+* With the power of the Wechaty Conversational RPA technology, your chatbot will have conversations on behalf of you, and can do whatever you want to do.
+
+* It works out of the box on **Linux**, **Mac** and **Windows**.
+
+* Supports all [puppets](../puppet-services) like Web, Pad, Windows and Mac.
+
+* It replies with a `dong` message when it recieves a `ding` message.


Please align the sentences structure under the list. For example:

Turn a WeChat/Whatsapp account into a chatbot, a.k.a Conversational User Interface Automation Software, with just a few lines of code.

Represent the user with the power of Wechaty Conversational RPA technology.

Work out of the box on Linux, Mac and Windows.

Support all puppets like Web, Pad, Windows and Mac.

Reply with a dong message when it recieves a ding message.

(Or you could rewrite the sentences yourself)

I have made the changes @proudofsimin

Hi @shwetalsoni,
Thank you for your prompt reply, but these sentences should all start from a verb and omit the subject. How do you think if we change the second one to "Use the chatbot to communicate or do anything on behalf of you."

Changed to Use the chatbot to communicate or do anything on behalf of you.

Rohitesh-Kumar-Jain

Perfect PR : clean commit history, properly based, relevant screenshots, PR good in scope.

proudofsimin

Thank you :)

lijiarui

Pls change as I request, thanks!

lijiarui · 2021-07-06T18:59:59Z

+
+You can run Wechaty on following platforms:
+* [Google Cloud Shell](getting-started/quick-start.mdx)
+* [Gitpod](getting-started/quick-start.mdx)


I thinks we should add an anchor for Google Cloud Shell and Gitpod link.

lijiarui · 2021-07-06T19:00:09Z

+
+You can run Wechaty on following platforms:
+* [Google Cloud Shell](getting-started/quick-start.mdx)
+* [Gitpod](getting-started/quick-start.mdx)


I thinks we should add an anchor for Google Cloud Shell and Gitpod link.

Actually, I think providing the link to pages is better because a user needs to follow some steps to run ding-dong bot on gitpod and google cloud shell. Going directly to gitpod/google cloud shell link without knowing how to operate it will be inconvenient for the user.

Ps: we have changed the structure in #922 PR. Inside Quick start there will be 2 different pages for Gitpod and Google cloud shell. So once this PR is merged I'll update the links here.

@shwetalsoni sure, could you file an issue illustrate this then we can tracking for this. Then I will approve this PR.

sure @lijiarui , I have updated the status of this PR here

lijiarui · 2021-07-06T19:00:38Z

+You can run Wechaty on following platforms:
+* [Google Cloud Shell](getting-started/quick-start.mdx)
+* [Gitpod](getting-started/quick-start.mdx)
+* [Locally on your machine](getting-started/hard-way.mdx)


I think we should change hard-way to running-locally after #888 changed as I requested.

Yeah sure, I'll change the file name to running-locally but here it can only be changed once #888 is merged

lijiarui · 2021-07-06T19:01:18Z

+Wechaty is a powerful software. You will learn the following fundamental features of Wechaty in the getting-started tutorials:
+
+* Turn a WeChat/Whatsapp account into a chatbot, a.k.a Conversational User Interface Automation Software, with just a few lines of code.
+


We should remove blank lines here.

lijiarui · 2021-07-06T19:02:13Z

+
+* Work out of the box on Linux, Mac and Windows.
+
+* Supports all [puppets](../puppet-services) like Web, Pad, Windows and Mac.


like Web, Pad, Windows and Mac. --> like Wechat, WhatsApp, WeCom, Lark and so on

changed to like Wechat, WhatsApp, WeCom, Lark and so on

…js.org into new-getting-started

This reverts commit 305eae8.

shwetalsoni · 2021-07-07T09:29:15Z

Hii @Rohitesh-Kumar-Jain @proudofsimin
I need some help with git. I accidently did git pull inside my new-getting-started branch and now the changes of others are also shown in my PR. I tried doing git revert to undo those but couldn't solve it. Can you please tell me how can i fix this.

This reverts commit 9de42fc.

lijiarui · 2021-07-08T18:32:54Z

@shwetalsoni You should change hard-way to running-locally, or the CI will keep red.

…js.org into new-getting-started

shwetalsoni · 2021-07-09T08:30:05Z

@lijiarui I have turned the CI green.

lijiarui

LGTM.

Looking forward to your new issue for tracking!

shwetalsoni · 2021-07-10T07:50:17Z

@lijiarui I have mentioned this PR here in this issue #1032

lijiarui

I found you delete the following files, which is unrelated to this PR:

jekyll/_contributors/simplepad.md
jekyll/_posts/2021-06-17-puppet-simplepad-hello.md
jekyll/assets/2021/06-puppet-simplepad-hello/logo.png
jekyll/assets/2021/06-puppet-simplepad-hello/process.png
jekyll/assets/contributors/simplepad/avatar.png

lijiarui

@shwetalsoni I found you delete the following files, which is unrelated to this PR, and it is a problem:

jekyll/_contributors/simplepad.md
jekyll/_posts/2021-06-17-puppet-simplepad-hello.md
jekyll/assets/2021/06-puppet-simplepad-hello/logo.png
jekyll/assets/2021/06-puppet-simplepad-hello/process.png
jekyll/assets/contributors/simplepad/avatar.png

Please recover these files. Please notice that each PR should not change other files

lijiarui · 2021-07-10T09:23:33Z

@shwetalsoni Since the .webp format has lots of advantages and the safari has supported it last year which means all the modern browsers will be able to compatible with it.

@huan has just added a new unit test for enforcing the image format: the CI will not be passed if we are using other image formats than the perfect .webp.

Please make CI green to adjust the new rule, see https://github.com/wechaty/wechaty.js.org/issues/1035

…js.org into new-getting-started

shwetalsoni · 2021-07-10T10:06:11Z

@lijiarui I have restored the files and also added images in webp format.

lijiarui

Good job, after I look deep into the introduction, I think maybe we can modify more about the introduction, pls change as I request, thanks!

lijiarui · 2021-07-10T11:26:50Z

+- [Gitpod](getting-started/quick-start.mdx)
+- [Locally on your machine](getting-started/running-locally.mdx)
+
+Wechaty is a powerful software. You will learn the following fundamental features of Wechaty in the getting-started tutorials:


Maybe we should change to the following saying instead of saying software, unify with Official Repo：

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).

lijiarui · 2021-07-10T11:34:44Z

+
+Wechaty is a powerful software. You will learn the following fundamental features of Wechaty in the getting-started tutorials:
+
+- Turn a WeChat/Whatsapp account into a chatbot, a.k.a Conversational User Interface Automation Software, with just a few lines of code.


Maybe we should add more IM introduction here:

Turn different instant messaging (IM) systems (such as WeChat, Wecom，Whatsapp, Lark，Gitter, and TikTok) account into chatbot.

lijiarui

Good job! Thanks for the contribution!

shwetalsoni added 2 commits June 10, 2021 16:10

0.8.294

a725a9a

updated getting-started-overview as suggested with new PR

6cef1f5

shwetalsoni requested a review from a team as a code owner June 10, 2021 11:57

shwetalsoni mentioned this pull request Jun 10, 2021

Getting started overview #897

Closed

shwetalsoni added GSoD 2021 tutorials Related to tutorial docs labels Jun 10, 2021

shwetalsoni mentioned this pull request Jun 10, 2021

Update and improve Tutorials section #891

Closed

33 tasks done

sbis04 reviewed Jun 12, 2021

View reviewed changes

shwetalsoni and others added 2 commits June 13, 2021 11:52

changed cloud IDE to google cloud shell

2f16358

Merge branch 'master' into new-getting-started

b27830e

proudofsimin requested changes Jun 13, 2021

View reviewed changes

shwetalsoni added 2 commits June 13, 2021 20:04

made suggested changes

aa89722

rephrased sentences

305eae8

Rohitesh-Kumar-Jain approved these changes Jun 14, 2021

View reviewed changes

proudofsimin approved these changes Jun 14, 2021

View reviewed changes

sbis04 approved these changes Jun 15, 2021

View reviewed changes

lijiarui mentioned this pull request Jul 6, 2021

GSoD Merging List #1026

Closed

lijiarui requested changes Jul 6, 2021

View reviewed changes

shwetalsoni added 4 commits July 7, 2021 13:03

Merge branch 'new-getting-started' of github.com:shwetalsoni/wechaty.…

1397093

…js.org into new-getting-started

removed blank lines

e2f376e

0.8.313

1268a8e

Revert "rephrased sentences"

b9b62d0

This reverts commit 305eae8.

Revert "add simplepad introduction (wechaty#951)"

a10ca74

This reverts commit 9de42fc.

shwetalsoni mentioned this pull request Jul 8, 2021

Features to be added later to tutorials section #1032

Closed

7 tasks done

lijiarui added 2 commits July 9, 2021 01:44

Merge branch 'master' into new-getting-started

e36ddb3

Merge branch 'master' into new-getting-started

d772dc5

Merge branch 'master' into new-getting-started

24b6b83

shwetalsoni added 2 commits July 9, 2021 13:45

fixing broken link

4c11d18

Merge branch 'new-getting-started' of github.com:shwetalsoni/wechaty.…

98b6b14

…js.org into new-getting-started

Merge branch 'master' into new-getting-started

3aa41b7

lijiarui approved these changes Jul 10, 2021

View reviewed changes

Merge branch 'master' into new-getting-started

2103aa5

lijiarui reviewed Jul 10, 2021

View reviewed changes

lijiarui requested changes Jul 10, 2021

View reviewed changes

Merge branch 'master' into new-getting-started

64d3613

shwetalsoni added 3 commits July 10, 2021 15:07

restored deleted files and uploaded the images in webp format

90b679c

Merge branch 'new-getting-started' of github.com:shwetalsoni/wechaty.…

e198b23

…js.org into new-getting-started

fixes

1d996b5

lijiarui requested changes Jul 10, 2021

View reviewed changes

applied suggested changes

e514003

lijiarui approved these changes Jul 10, 2021

View reviewed changes

huan approved these changes Jul 10, 2021

View reviewed changes

huan merged commit 00d0733 into wechaty:master Jul 10, 2021

		Wechaty is a powerful software. You will learn the following fundamental features of Wechaty in the getting-started tutorials:

		* Turn a WeChat/Whatsapp account into a chatbot, a.k.a Conversational User Interface Automation Software, with just a few lines of code.


		* Work out of the box on Linux, Mac and Windows.

		* Supports all [puppets](../puppet-services) like Web, Pad, Windows and Mac.


		Wechaty is a powerful software. You will learn the following fundamental features of Wechaty in the getting-started tutorials:

		- Turn a WeChat/Whatsapp account into a chatbot, a.k.a Conversational User Interface Automation Software, with just a few lines of code.

Conversation

shwetalsoni commented Jun 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shwetalsoni commented Jun 10, 2021

Uh oh!

shwetalsoni commented Jun 10, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rohitesh-Kumar-Jain commented Jun 12, 2021

Uh oh!

proudofsimin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rohitesh-Kumar-Jain left a comment

Choose a reason for hiding this comment

Uh oh!

proudofsimin left a comment

Choose a reason for hiding this comment

Uh oh!

lijiarui left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shwetalsoni Jul 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shwetalsoni commented Jul 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lijiarui commented Jul 8, 2021

Uh oh!

shwetalsoni commented Jul 9, 2021

Uh oh!

lijiarui left a comment

Choose a reason for hiding this comment

Uh oh!

shwetalsoni commented Jul 10, 2021

Uh oh!

lijiarui left a comment

Choose a reason for hiding this comment

Uh oh!

lijiarui left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lijiarui commented Jul 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shwetalsoni commented Jul 10, 2021

Uh oh!

shwetalsoni commented Jun 10, 2021 •

edited

Loading

shwetalsoni Jul 7, 2021 •

edited

Loading

shwetalsoni commented Jul 7, 2021 •

edited

Loading

lijiarui left a comment •

edited

Loading

lijiarui commented Jul 10, 2021 •

edited

Loading