wechaty / docusaurus

Wechaty Official Website for Documentations, Powered by Docusaurus.
https://wechaty.js.org/docs/
Other
112 stars 347 forks source link

Some good content should add back to the doc #1089

Open lijiarui opened 3 years ago

lijiarui commented 3 years ago

As https://github.com/wechaty/wechaty.js.org/pull/870/files#diff-fd47a25eaa8054d71a6781434e1c57dab39cc93746f29d0d69ab0051d5583ecdL69 request, it deletes the following content, and I think it's right.

But I think it should not be shown on the overview page, but it should put somewhere, so I file an issue here and looking forward to putting the following back somewhere at the doc in the future.

## The development process

Learn about the various components and tools to help you in the development and testing of Wechaty chatbot applications:

<!--
- **Settings**: [Overview]() | [Full list of settings]()
- **Chatbot applications**: [Overview]()
- **Exceptions**: [Overview]()
-->

- **Testing**: [Mock](puppet-providers/mock.md) | [Writting and running tests](https://github.com/wechaty/wechaty-vorpal-contrib/blob/master/src/contrib/math_master/math_master.spec.ts)
- **Deloyment**: [Docker](tutorials/docker.md) | [Heroku](https://github.com/wechaty/heroku-wechaty-getting-started)

## Common Chatbot application tools

- [FileBox](https://github.com/huan/file-box): helper module for easy processing files between the local filesystem and the network.
- [Brolog](https://github.com/huan/brolog): helper module for easy logging between the Node.js and the Browser environments. (Angular Dependency Injection supported)
- [FlashStore](https://github.com/huan/flash-store): helper module for key-value persistant storage in both Node.js local filesystem and Browser(tbw). Follows the [ES6 Map API](https://github.com/huan/async-map-like#readme).
- [MemoryCard](https://github.com/huan/memory-card): help module for key-value persistant storage in cloud. (should be a cloud native module in the future). Follows the [ES6 Map API](https://github.com/huan/async-map-like#readme).

## Other core functionalities

Learn about some other core functionalities of the Wechaty:

- [TOKEN specification](specs/token.md)
- [Puppet specification](specs/puppet.md)

## The Wechaty open-source project

Learn about the development process for the Wechaty project itself and about how you can contribute:

- **Commmunity**: [How to get involved](contributing/overview.md) | [Team organization](https://github.com/wechaty/PMC) | [The Wechaty source code repository](https://github.com/wechaty/wechaty) | [Mailing lists](https://groups.google.com/g/wechaty) | [Gitter.im channel](https://gitter.im/wechaty/wechaty) | [Wechaty contributor program](contributing/contributor-program.md)
- **Documentation**: [About this documentation](contributing/documentation.md)
- Wechaty over time: [Release notes](https://github.com/wechaty/wechaty/releases)
Rohitesh-Kumar-Jain commented 3 years ago

What about creating a general label called "documentation" and putting that as well along with the existing label. Because this issue has a bigger scope than GSoD 2021.

lijiarui commented 3 years ago

Sure, I will change add a new label. If GSoD tech writers are interested in this part, we'll be happy they can contribute.