docusaurus icon indicating copy to clipboard operation
docusaurus copied to clipboard

Conflicting and redundant Getstart in Offical site and github. Keeping content in one place maybe get nice user experience.

Open atubo2012 opened this issue 4 years ago • 4 comments

  • Providing detail content of getstart on official site(https://wechaty.js.org/docs/getting-started) is unnecessary , because it is really hard to synchronize them and make no sense ,so suggest to keep the LINK of Getstart on github(https://github.com/wechaty/wechaty-getting-started) on official site .

image

  • Content of getstart in here (https://github.com/wechaty/wechaty#triangular_flag_on_post-getting-started) should be replace by LINK to https://github.com/wechaty/wechaty-getting-started

image

Developer's experience and journey matters!

atubo2012 avatar Feb 20 '21 15:02 atubo2012

Hi @atubo2012 ,

I definitely agree with you: Developer's experience and journey matters!

So we are always trying to improve our docs in the past years.

However, our open-source organization has very limited resources to make everything good enough, so we always need help from more community members.

The developers like you who can file an issue to point out the problems we have are very helpful for the community, and it would be great if you can also create a Pull Request to fix the problem that you find by yourself!

Please feel free to keep posting any issues that you found, I'll keep my eyes on it. And PR is welcome!

huan avatar Feb 20 '21 15:02 huan

Hi @atubo2012 ,

I definitely agree with you: Developer's experience and journey matters!

So we are always trying to improve our docs in the past years.

However, our open-source organization has very limited resources to make everything good enough, so we always need help from more community members.

The developers like you who can file an issue to point out the problems we have are very helpful for the community, and it would be great if you can also create a Pull Request to fix the problem that you find by yourself!

Please feel free to keep posting any issues that you found, I'll keep my eyes on it. And PR is welcome!

My pleasure :) But PR is ?

atubo2012 avatar Feb 21 '21 00:02 atubo2012

PR is Pull Request. Here's a GitHub doc for PR: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

The guide is more practical :)

https://gitbook.tw/chapters/github/pull-request.html

atubo2012 avatar Feb 21 '21 15:02 atubo2012