Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSDoc bugs #1475

Closed
2 of 3 tasks
huan opened this issue Jul 12, 2018 · 2 comments
Closed
2 of 3 tasks

JSDoc bugs #1475

huan opened this issue Jul 12, 2018 · 2 comments
Labels

Comments

@huan
Copy link
Member

huan commented Jul 12, 2018

  • Comments in examples should be // instead of #
  • Use Wiki links only from Wechaty. The wiki in wechaty-getting-started repository will be closed when we publish v0.20
  • Link to examples by link with a specific version to prevent the future 404 error.
    • Good: https://github.com/Chatie/wechaty/blob/621134faf1897a7009849ad47d60f15520b19877/bin/io-client.ts, instead of
    • Bad: https://github.com/Chatie/wechaty/blob/master/examples/contact-bot.ts

See Also

https://chatie.io/wechaty

@huan huan added the bug label Jul 12, 2018
@lijiarui
Copy link
Member

Use Wiki links only from Wechaty. The wiki in wechaty-getting-started repository will be closed when we publish v0.20

Should discuss more this because wiki should have a more clear list.

Another suggetion is to deploy https://qhduan.github.io/wechaty-doc/ to the official link.

@huan
Copy link
Member Author

huan commented Jul 12, 2018

I'll consider it later.

lijiarui added a commit to lijiarui/wechaty that referenced this issue Jul 13, 2018
lijiarui added a commit to juzibot/wechaty-doc that referenced this issue Jul 13, 2018
@huan huan closed this as completed in 9690344 Jul 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants