python-wechaty icon indicating copy to clipboard operation
python-wechaty copied to clipboard

🔥 🔥 python-wechaty 文档编写招募 ~~ 🔥 🔥

Open wj-Mcat opened this issue 3 years ago • 9 comments

初衷

有很多初学者在使用python-wechaty时,发现很难上手,其中一个最大的原因在于没有一个成体系的文档系统,而且这个文档理应早就应该有了,在此,我欢迎所有使用过python-wechaty的用户,共同来完善项目文档,并会持续更新。

目前只考虑中文版本,面向国内优秀开发者。文档地址: https://python-wechaty.readthedocs.io/

文档结构参考:documentation system

目录

  • 首页
  • 介绍
    • [x] 使用免费Web协议 @wj-Mcat
    • [x] 使用Padlocal 协议 @wj-Mcat
    • [x] 开始上手 @wj-Mcat
    • [x] 相关视频 @wj-Mcat
  • 开箱即用
    • [ ] 如何添加好友
    • [ ] 关键字入群
    • [ ] 管理群成员
    • [ ] 定时任务
  • 模块详解
    • [x] 介绍 @wj-Mcat
    • [ ] Wechaty 模块
    • [ ] 消息模块
    • [ ] 联系人模块
    • [ ] 好友关系模块
    • [ ] 群聊模块
    • [ ] 群聊邀请
  • FAQ
    • [x] 基础常见问题 @wj-Mcat
    • [x] 什么是Puppet @wj-Mcat

如何参与编写

大家可以参考以上目录中的章节,挑选其中自己感兴趣的,或者有其他的意见的话,请在评论区描述你想要参与编写的章节或想法(注意⚠️,一定要写章节编号,避免与其他人重复),大家可以一起参与相关讨论。

如果各位已经发起PR的话,便在评论中将目标pr link过来,这样大家都可以看到对应的进度。

最后,非常期待以及感谢大家的参与 ~~

如何参与贡献:how-to-contribute-for-docs

wj-Mcat avatar Apr 25 '21 14:04 wj-Mcat

报名,请给我一些小的活儿。多了绝对莫有空。

why2lyj avatar Apr 26 '21 02:04 why2lyj

有时间,也感兴趣,如何加入?

harrisonyao avatar Apr 26 '21 02:04 harrisonyao

@why2lyj @harrisonyao 请各位阅读以上文档,挑选感兴趣的章节,然后发起PR来共同维护文档内容,非常感谢大家的参与,期待大家的文档内容。

wj-Mcat avatar Apr 26 '21 03:04 wj-Mcat

ping @harrisonyao @why2lyj

wj-Mcat avatar Apr 28 '21 08:04 wj-Mcat

报名。

newalors avatar May 01 '21 02:05 newalors

@wj-Mcat 您好,我去看docs里面文档,发现本文目录中的一部分已经完成,我建议已经完成的部分,在目录里面勾选check一下,同时将中文翻译目录放上,方便其他人选择章节进行编写。我本人希望参与以下章节的编写。

  • Tutorials
    • [ ] 2.1 tutorials/friendship.md

mrwis avatar May 20 '21 13:05 mrwis

Oh, of course. Thank you very much for your advice. I will check the options that have been completed.

I'm looking forward to your contribution. @mrwis

wj-Mcat avatar May 21 '21 11:05 wj-Mcat

我选者 群聊模块, 我发现这个模块实例都是 js 代码,我可以替换成 Python 代码

jiaqianjing avatar Aug 19 '21 06:08 jiaqianjing

我选者 群聊模块, 我发现这个模块实例都是 js 代码,我可以替换成 Python 代码

Hoping for your great pr.

wj-Mcat avatar Aug 19 '21 15:08 wj-Mcat