Improve the Introduction and Explanations section of Wechaty.js.org project - GSOD

[nibble0101]

Issue description

This issue is to keep track of Improve the Introduction and Explanation sections secondary project under Google Season of docs 2021.

Technical writers

• Joseph Mawa
• Chris Estepa

Introduction Section

Week	Sub section	PR	Technical Writer
1	Overview of Wechaty documentation	#870	Joseph Mawa
1	What is Wechaty	#871	Joseph Mawa
1	What can you do with Wechaty	#873	Chris Estepa
2	Who are the users of Wechaty	#900	Chris Estepa and Joseph Mawa
2	Getting started with Wechaty	#899	Joseph Mawa
2	Main concepts in Wechaty	#904	Chris Estepa and Joseph Mawa

Explanation Section

Week	Sub section	PR	Technical Writer
3	Overview of the explanations section	#915	Chris Estepa
3	Wechaty chatbot development life cycle	#918	Joseph Mawa
4	Software Development Kit	#930	Chris Estepa
4	Wechaty chatbot testing	#936	Joseph Mawa
5	Wechaty DevOps tools	#949	Joseph Mawa
5	Troubleshooting in Wechaty	#950	Chris Estepa
6	Wechaty chatbots architecture	#977	Joseph Mawa

Live project clone

The above changes have been deployed to a clone of wechaty.js.org site. You can view it here. You can comment on this issue or the respective PR for any suggestions.

[Rohitesh-Kumar-Jain]

1) Can you pls get these in sync ?

[Rohitesh-Kumar-Jain]

2) contains technical ~reference~ references

[Rohitesh-Kumar-Jain]

3) ~provide~ provides

[Rohitesh-Kumar-Jain]

4. Spelling of attachment

[Rohitesh-Kumar-Jain]

5. Can we remove V0.56? Link to Wechaty release notes is fine, as mentioning version in documentation is not a great idea, as it will get outdated, and will require maintenance.

[Rohitesh-Kumar-Jain]

6. I see a punctuation error Rust) ,

[Rohitesh-Kumar-Jain]

7. Can we come up with some other title other than What is Wechaty's story ?

In China, Wechat is the nation's internet

I am not Chinese but still I fell that this can't be the case, Wechat is probably the nation's chat messaging but I am pretty sure not internet.

I leave this on @huan 😅

[Rohitesh-Kumar-Jain]

8. Another thing I felt is, that your documentation uses a lot of which at places, where I think that must be used, this is what I feel. This probably is acceptable so i guess we are fine.

[Rohitesh-Kumar-Jain]

9. Spelling of discusses

10. also it should be each of the components

[Rohitesh-Kumar-Jain]

11. What about having a simple diagram for chatbot development cycle

[nibble0101]

@Rohitesh-Kumar-Jain Thanks for the observations. It is a lot easier to spot some of those mistakes on a deployed site than from PRs. We shall surely work on them as we start polishing in the coming week. About the chatbot development cycle, we wanted to first get the approval of as many people as possible on that section so that we work on it once. We have noted it in our todo. Thanks for the feedback.

[Rohitesh-Kumar-Jain]

Yes thanks for deploying that

[Rohitesh-Kumar-Jain]

12. Typo

[Rohitesh-Kumar-Jain]

13. Typo

[Rohitesh-Kumar-Jain]

14. Do you mean version ?

[Rohitesh-Kumar-Jain]

Hi everyone,

I have gone through all the documentation submitted by Chris and Joseph, and have pointed out the enhancements I feel could be done. I don't have any more suggestions and feedback for this team and project.

MY FINAL EVALUATIONS FOR THIS TEAM & PROJECT : PASS

Now I would like to request @proudofsimin for her reviews so that they can finish polishing their documentation and would like to request @huan and @lijiarui for thier feedback as well.

[nibble0101]

1. Do you mean version ?

Apparently it is verion according to the usage notes on npm. Probably it is a typo. Can you make some clarification here @huan?

[lijiarui]

Hi everyone,

I have gone through all the documentation submitted by Chris and Joseph, and have pointed out the enhancements I feel could be done. I don't have any more suggestions and feedback for this team and project.

MY FINAL EVALUATIONS FOR THIS TEAM & PROJECT : PASS

Now I would like to request @proudofsimin for her reviews so that they can finish polishing their documentation and would like to request @huan and @lijiarui for thier feedback as well.

Hi @Rohitesh-Kumar-Jain How do you think we follow PR Reviewing & Approving Rules as @huan drafted at meeting notes before：

PR gets all volunteer approval as well as same team member approval, then adding this to ready to merge tag. We will review them.

[huan]

@nibble0101 Thank you very much for mention me: yes it's a topo, and I have just fixed it by this commit

Apparently it is verion according to the usage notes on npm. Probably it is a typo. Can you make some clarification here @huan?

[Rohitesh-Kumar-Jain]

Hi,

I am happy to follow them.

Apart from the high priority PRs, there some small PRs that involve minor corrections and minor changes, they can be merged real quick. Should I create a list for that as well? Some other PRs like proposals of not-selected candidates aren't of high priority but are yet to merge.

Merging/closing those PRs will actually help to clear the PR backlog faster.

Best, Rohitesh

On Sun, Jul 11, 2021 at 6:56 PM lijiarui @.***> wrote:

MY FINAL EVALUATIONS FOR THIS TEAM & PROJECT : PASS

Hi @Rohitesh-Kumar-Jain https://github.com/Rohitesh-Kumar-Jain How do you think we follow PR Reviewing & Approving Rules https://github.com/wechaty/wechaty.js.org/issues/1045 as @huan https://github.com/huan drafted at meeting notes https://docs.google.com/document/d/1fVCk8qRYc4RKGMf2UY5HOe07hEhPUOpGC34v88GEFJg/edit#heading=h.zafxuczi76z5 before：

PR gets all volunteer approval as well as same team member approval, then adding this to ready to merge tag. We will review them.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/wechaty/wechaty.js.org/issues/872#issuecomment-877799752, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOZHDDL3WWTCIRBMAIWKHZLTXGLYDANCNFSM45E42VAQ .

[lijiarui]

@Rohitesh-Kumar-Jain Sure, as long as the PR gets same team member's and two volunteer's approval, you think we should review quickly, you can create a list, assign the issue to me and add the ready to merge tag for the PR. I will try my best to deal with them in two days in July.

[Rohitesh-Kumar-Jain]

as long as the PR gets same team member's and two volunteer's approval, you think we should review quickly, you can create a list, assign the issue to me and add the ready to merge tag for the PR.

Yes seems good to me

[proudofsimin]

Hi @nibble0101 and @chris-4444, I would like to check that are there any changes from #950 ? I saw that I have provided some feedback and did not seem to receive any feedback yet.