Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
add wechaty document #725
Thanks for all those hard works for the documentation, I believe it will help other developers a lot after published.
There have two additional jobs of this PR:
- Please also generate the MarkDown file for the jsdoc by run
npm run docand make sure the generated document file at
docs/index.mdis what we want.
- Please add
@privateto all the methods/functions which are not listed at the README API Reference section because they are just for internal use and should not be treat as published API
I also post all my reviews to the PR, please follow them as well.
here is the auto generate doc: https://github.com/lijiarui/wechaty/blob/new-doc/docs/index.md
not sure why it has double wechaty intro....
will keep on dig in it, or anyone can help? @ax4
In our current implementation of the doc generator script
BTW: I saw lots of
Thanks for the update, it looks better now.
Could you please include the
docs/index.md in the next PR?
Please make sure that the index.md file content is expected.
Have a nice weekend!
The jsdoc looks better to me now, thank you very much for all the work of writing the documents and examples!
I have some minor reviews. After resolved them, I'll be able to vote for my approvement.
Great job! The documentation looks good to me.
There might be something need to be modified, but I would suggest merge this PR and do these updates in successor PRs.