The reference guide contain the technical description of the machinery. They are code determined and information oriented. The references guides contain clear descriptions of Classes, API, Functions, Methods, Attributes, and many more technical aspects of the software. The Wechaty references aim to guide the end-users completely about Wechaty. The refernces guide will contain the following subsections with the described content below 👇
- API References Add use cases for API references, add code snippets and also add details about user classes.
- Polyglot Add code snippets with easy-to-understand examples for first-time users in different programming languages.
- Puppet Providers Add separate modules for each of the messaging apps and add necessary code snippets.
- Puppet Services Include all the puppet services offered by Wechaty.
- Created a new ,brief and a clean documentation structure for References section.
- Created a user friendly documentation with new information ,code snippets,images for the end-users to understand the Wechaty RPA BOT better.
You can find all PRs done by us in the links below:
| Pull Requests | Technical Writer | Status |
|---|---|---|
| Update Puppet Providers overview #1107 | Soumi Bardhan |  |
| Update Puppet Providers : WeChat #1108 | Soumi Bardhan | |
| Update Puppet Providers : Gitter #1110 | Soumi Bardhan | |
| Update Puppet Providers : Padlocal #1195 | Soumi Bardhan | |
| Update Puppet Providers : Official Account #1208 | Soumi Bardhan | |
| Update Puppet Providers : WeChat4U #1211 | Soumi Bardhan | |
| Update Puppet Providers : Service #1212 | Soumi Bardhan | |
| Update Puppet Providers : Mock #1220 | Soumi Bardhan | |
| Update Puppet Services : Overview #1277 | Soumi Bardhan | |
| Update Puppet Services : Padlocal #1278 | Soumi Bardhan | |
| Update Puppet Services : FAQ #1284 | Soumi Bardhan | |
| Update Puppet Services : WXWork #1285 | Soumi Bardhan | |
| Pull Requests | Technical Writer | Status |
|---|---|---|
| Week-4 added the Wechaty environment variables #933 | Shraddha Vasant Prasad |  |
| Week-5 Updated the Wechaty Puppet Service #965 | Shraddha Vasant Prasad |  |
| Week-6 Updated the puppet.md file#972 | Shraddha Vasant Prasad |  |
| Week-7 Wechaty Polyglot #1013 | Shraddha Vasant Prasad |  |
| Updated the Go-Wechaty #1050 | Shraddha Vasant Prasad |  |
| Update the Python-Wechaty #1057 | Shraddha Vasant Prasad |  |
| Scala-Wechaty #1096 | Shraddha Vasant Prasad |  |
| The .NET Wechaty #1100 | Shraddha Vasant Prasad |  |
| The PHP-Wechaty #1156 | Shraddha Vasant Prasad |  |
| Rust-Wechaty #1231 | Shraddha Vasant Prasad |  |
| Added Polyglot Architecture image #1233 | Shraddha Vasant Prasad |  |
| Updated the API references overview section #1261 | Shraddha Vasant Prasad |  |
| Updated room-invitation section #1265 | Shraddha Vasant Prasad |  |
| changed the side label for resolving the left bar navigation #1273 | Shraddha Vasant Prasad |  |
| Updated the Polyglot Do it yourself section #1283 | Shraddha Vasant Prasad |  |
| Update Main references overview #1286 | Shraddha Vasant Prasad |  |
| Update the friendship class section #1289 | Shraddha Vasant Prasad |  |
| Update contacts in API references #1290 | Shraddha Vasant Prasad |  |
| Updated the Room section in API references #1294 | Shraddha Vasant Prasad |  |
I am glad to have got the chance and opportunity to be a part of the Google Season of Docs 2021 program organized by Google. The learning curve in the whole journey has been high. The program has helped me to:
- Understand the importance of Technical documentation.
- Learn about Docusaurus and MDX(Markdown+ReactJS).
- Learn about RPA (Robotic Process Automation) bots.
- Get involved in an innovative community that is Wechaty.
I am thankful to Google Season of Docs and Wechaty for giving me this opportunity. I would also like to thank my mentors Huan LI and Li Jiarui for their constant support and lastly would like to thank the volunteers Simin Liao and Rohitesh Kumar Jain for their constant support.They led the video meetings in a well-organized, interactive manner and made the meetings a great platform for discussion.
- Continue to work towards contributing to Wechaty community.
- Detect and rectify issues in implementation of the RPA bot if any in the future.