added tutorial for qr-code-terminal plugin by shwetalsoni · Pull Request #969 · wechaty/docusaurus

shwetalsoni · 2021-06-23T08:27:20Z

Added tutorial for QR code terminal plugin.

shwetalsoni · 2021-06-23T08:29:52Z

proudofsimin

Hi, could you explain more about this plugin at the beginning? Is it the users (developers) or customers will scan the QR code? What will the developers receive when someone scan the QR code? And what will it show on phone after scanning the QR code?

proudofsimin · 2021-06-23T14:39:05Z

+npm i wechaty-plugin-contrib
+```
+
+## 2. Integrating the plugin


remove the v-ing form. Use imperative sentence.

proudofsimin · 2021-06-23T14:39:35Z

+bot.start()
+```
+
+## 3. Running the bot


remove the v-ing form. Use imperative sentence.

shwetalsoni · 2021-06-23T15:11:29Z

Hi, could you explain more about this plugin at the beginning? Is it the users (developers) or customers will scan the QR code? What will the developers receive when someone scan the QR code? And what will it show on phone after scanning the QR code?

Hii simin,
Actually this plugin is just for demonstrating that how a user can use this plugin in their bot. So, now on scanning this qr code it wont do anything.

I think for better explanation I can provide a conclusion at end reffering to ding dong bot because there we have used this plugin. On scanning that qr code users can connect to whatsapp and wechat.

What do you think or is their any better way to do this ?

proudofsimin

Hi @shraddhavp,

Let me clear up. So in here, you use the plugin to generate a QR code first, and then you are required to use the events (are they called events?) to define the function for it. Am I right? I agree with your suggestion that mentioning a real example really helps me/user to clear it up. Thank you.

shwetalsoni · 2021-06-27T08:16:00Z

Hii @proudofsimin
I have changed ing(s) to imperative form.
I have also added conclusion section at end describing about the application of QR code terminal plugin.
I have updated the screenshots for better understanding.
Thank you :)

shwetalsoni · 2021-06-27T08:19:38Z

Hi @shraddhavp,

Let me clear up. So in here, you use the plugin to generate a QR code first, and then you are required to use the events (are they called events?) to define the function for it. Am I right? I agree with your suggestion that mentioning a real example really helps me/user to clear it up. Thank you.

yeah, you get it right. I have made the changes now. You can review it.
Btw it's not @shraddhavp 😅

proudofsimin · 2021-06-29T15:51:42Z

Hii @proudofsimin
I have changed ing(s) to imperative form.
I have also added conclusion section at end describing about the application of QR code terminal plugin.
I have updated the screenshots for better understanding.
Thank you :)

Thanks for the modification and adding the starter bot. Could you put the "create the starter bot" in step one like #963 ? Thank you.

P.s. sorry for linking the wrong name...

proudofsimin

Since it's only minor modification left, approve first.

shwetalsoni · 2021-06-30T07:13:14Z

Hii @proudofsimin
I have changed ing(s) to imperative form.
I have also added conclusion section at end describing about the application of QR code terminal plugin.
I have updated the screenshots for better understanding.
Thank you :)

Thanks for the modification and adding the starter bot. Could you put the "create the starter bot" in step one like #963 ? Thank you.

P.s. sorry for linking the wrong name...

I have added this step

lijiarui

Pls change as I request.

lijiarui · 2021-07-06T19:04:41Z

+
+### 1. Create a starter bot
+
+Follow the instructions on the **Starter Bot** page to create the foundation of a Wechaty bot.


I think we should add a starter bot link here for Starter Bot

Yeah, I will add the link here. Started Bot will be under examples/basic/. We have this section in the upcoming weeks in our proposal. So once the starter bot is added and merged we can provide the link here.

I think you could file a new issue for this. Once you create a new issue, I will ignore this part.

lijiarui · 2021-07-06T19:06:20Z

+
+Now, you are done with the integration of `QR code terminal plugin` with your bot. For running the bot you have to **export/set** an environment variable with the type of puppet to use and then run the bot.
+
+#### Linux/macOS


I think we should unify the style here, you did a good job at #888 , it looks like this：

You can use code like this:

<Tabs groupId="operating-systems" defaultValue="linux" values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'mac', }, { label: 'Windows', value: 'windows', }, ] }> <TabItem value="linux">

lijiarui · 2021-07-06T19:06:39Z

+You can use this `QR code terminal` plugin for building the bots where you have to connect to a device. You can refer to [Ding Dong bot](../getting-started/hard-way.mdx). In ding dong bot you have to scan the generated QR code to connect to **Whatsapp/Wechat**.
+
+## References
+


Add video link reference here: https://www.youtube.com/watch?v=tfGZXoe_aA4

lijiarui · 2021-07-06T19:06:58Z

+## References
+
+* [GitHub repository of Wechaty Plugin Contrib](https://github.com/wechaty/wechaty-plugin-contrib)
+


Pls remove blank lines here.

shwetalsoni · 2021-07-07T07:10:09Z

@lijiarui I have made the suggested changes except for the starter bot link which I'll add later when the starter bot is created and merged.

lijiarui · 2021-07-07T17:13:43Z

Good job! After you file a new issue for this and link to this PR, I will approve this PR.

shwetalsoni · 2021-07-08T08:25:09Z

@lijiarui I have created issue #1032 for keeping the record of all the features that need to be added later mentioning all the respective PR's.

lijiarui

Good job！ Appoved

added tutorial for qr-code-terminal plugin

0dfd045

shwetalsoni requested review from a team as code owners June 23, 2021 08:27

shwetalsoni mentioned this pull request Jun 23, 2021

Update and improve Tutorials section #891

Closed

33 tasks done

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

proudofsimin requested changes Jun 23, 2021

View reviewed changes

proudofsimin reviewed Jun 24, 2021

View reviewed changes

refactored tutorial

9270001

fixed typo

d2585df

proudofsimin approved these changes Jun 29, 2021

View reviewed changes

added "create starter bot section"

877303f

lijiarui mentioned this pull request Jul 6, 2021

GSoD Merging List #1026

Closed

lijiarui requested changes Jul 6, 2021

View reviewed changes

shwetalsoni added 2 commits July 7, 2021 12:37

fixed style, removed blank lines and added video

0cd5e3e

changes file from .md to .mdx

7f47f1a

shwetalsoni mentioned this pull request Jul 8, 2021

Features to be added later to tutorials section #1032

Closed

7 tasks done

lijiarui approved these changes Jul 8, 2021

View reviewed changes

huan approved these changes Jul 8, 2021

View reviewed changes

Merge branch 'master' into qr-code-terminal-plugin

4673618

lijiarui merged commit 38c5a71 into wechaty:master Jul 8, 2021


		### 1. Create a starter bot

		Follow the instructions on the Starter Bot page to create the foundation of a Wechaty bot.


		Now, you are done with the integration of `QR code terminal plugin` with your bot. For running the bot you have to export/set an environment variable with the type of puppet to use and then run the bot.

		#### Linux/macOS

		You can use this `QR code terminal` plugin for building the bots where you have to connect to a device. You can refer to [Ding Dong bot](../getting-started/hard-way.mdx). In ding dong bot you have to scan the generated QR code to connect to Whatsapp/Wechat.

		## References

		## References

		* [GitHub repository of Wechaty Plugin Contrib](https://github.com/wechaty/wechaty-plugin-contrib)

Conversation

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

Uh oh!

Uh oh!

shwetalsoni commented Jun 23, 2021

Uh oh!

proudofsimin left a comment

Choose a reason for hiding this comment

Uh oh!

proudofsimin Jun 23, 2021

Choose a reason for hiding this comment

Uh oh!

proudofsimin Jun 23, 2021

Choose a reason for hiding this comment

Uh oh!

shwetalsoni commented Jun 23, 2021

Uh oh!

proudofsimin left a comment

Choose a reason for hiding this comment

Uh oh!

shwetalsoni commented Jun 27, 2021

Uh oh!

shwetalsoni commented Jun 27, 2021

Uh oh!

proudofsimin commented Jun 29, 2021

Uh oh!

proudofsimin left a comment

Choose a reason for hiding this comment

Uh oh!

shwetalsoni commented Jun 30, 2021

Uh oh!

lijiarui left a comment

Choose a reason for hiding this comment

Uh oh!

lijiarui Jul 6, 2021

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!

lijiarui Jul 7, 2021

Choose a reason for hiding this comment

Uh oh!

lijiarui Jul 6, 2021

Choose a reason for hiding this comment

Uh oh!

lijiarui Jul 6, 2021

Choose a reason for hiding this comment

Uh oh!

lijiarui Jul 6, 2021

Choose a reason for hiding this comment

Uh oh!

shwetalsoni commented Jul 7, 2021

Uh oh!

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

Uh oh!

Uh oh!

shwetalsoni commented Jul 8, 2021

Uh oh!

lijiarui left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shwetalsoni commented Jun 23, 2021 •

edited

Loading

shwetalsoni Jul 7, 2021 •

edited

Loading

lijiarui commented Jul 7, 2021 •

edited

Loading