Overview of Wechaty Documentation

Overview of Wechaty Documentation​

This section is a high-level overview of how the Wechaty Documentation is structured. It will help you use the documentation more effectively by guiding you on where to look for specific information.

The Wechaty Documentation covers everything you need to know about Wechaty. It comprises of five broad sections and these sections are:

• Introduction section
• Tutorials section
• How to Guides section
• References section
• Explanations section

Introduction​

The Introduction section provides an in-depth introduction to Wechaty, Wechaty community, and the Wechaty ecosystem. It has been tailored for both beginners and experienced Chatbot makers. This section comprehensively covers the following:

• Introduction to Wechaty
• What can you do with Wechaty
• The users of Wechaty
• Getting started with Wechaty
• The main concepts in Wechaty
• Showcases
• Case study
• Wechaty community
• Contributing to Wechaty
• Changelog

Tutorials​

Note: If you are an absolute beginner, we recommend you to start with the Introduction to familiarize yourself with Wechaty, Wechaty community, and the Wechaty ecosystem

This is a learning-oriented section which consists of two levels of tutorials:

• Beginner tutorials
• Advanced tutorials

Beginner tutorials

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.

Advanced tutorials

The advanced tutorials require you to have at least intermediate to advanced knowledge of Wechaty and chatbot development. If you are an experienced Wechaty developer, you can go ahead and explore the other sections of the documentation like How to Guides, Reference Guides, and the Explanation section as well to gain more insights about Wechaty.

How to Guides​

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 and Tutorials sections before going to the How to Guides.

Reference Guides​

Prerequisite: You should have basic understanding of Wechaty and familiarity with the key concepts in Wechaty and Chatbot application development in general.

The Reference Guide contains technical references for Wechaty APIs and other aspects of Wechaty's machinery. It describes the various functionalities provided by Wechaty. You can always refer to this section to learn more about classes, functions, modules, and other aspects of Wechaty's machinery you come across.

Explanations​

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 and Tutorials sections of the documentation.