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

Overview sub-section of the Introduction section #870

Merged
merged 20 commits into from
Jul 16, 2021

Conversation

nibble0101
Copy link
Contributor

@nibble0101 nibble0101 commented May 19, 2021

Improve the Introduction and Explanations project

Section Sub-section Author
Introduction Overview Joseph Mawa

This the Overview sub-section of the Introduction section

image
image
image
image
image
image

Overview sub-section of the Introduction section
By Joseph Mawa
@nibble0101 nibble0101 requested a review from a team as a code owner May 19, 2021 11:46
@nibble0101 nibble0101 marked this pull request as draft May 19, 2021 11:46
@nibble0101 nibble0101 changed the title Overview of wechaty documentation Overview sub-section of the Introduction section May 19, 2021
@nibble0101 nibble0101 self-assigned this May 19, 2021
@nibble0101 nibble0101 marked this pull request as ready for review May 20, 2021 11:19
@Rohitesh-Kumar-Jain
Copy link
Contributor

@proudofsimin

Copy link
Contributor

@proudofsimin proudofsimin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nibble0101,

Overall this is a very great document! I left some comments below and also reference of Google style. Feel free to let me know if you have any question.

docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
@huan
Copy link
Member

huan commented May 23, 2021

@proudofsimin Thank you very much for your comments to improve this PR, I believe they are very valuable.

We should strictly follow the Documentation System for our docs contributing, @nibble0101 please follow the suggestions from @proudofsimin and make sure all our docs can be adaptered to the Documentation System, appreciate it!

@nibble0101
Copy link
Contributor Author

nibble0101 commented May 23, 2021

I don't think CI is failing because of the commit I made above.
image

@huan
Copy link
Member

huan commented May 23, 2021

I don't think CI is failing because of the commit I made above.

Yes, it's not related to this PR.

Sorry for that, I'm fixing it now.

@nibble0101 nibble0101 requested a review from proudofsimin May 25, 2021 09:15
Copy link
Contributor

@proudofsimin proudofsimin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nibble0101,

Wow I love it so much! Please correct just three minor typos. Thank you.

docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
@nibble0101 nibble0101 added the introduction Pull requests that update introduction section of the documentation label May 26, 2021
Copy link
Contributor

@Rohitesh-Kumar-Jain Rohitesh-Kumar-Jain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work guys, and thanks for fixing the typos
ping @huan

@lijiarui
Copy link
Member

lijiarui commented Jul 10, 2021

@nibble0101 Please resolve the conflict first.

And @Rohitesh-Kumar-Jain As GSoD Project PR Review Rules in https://github.com/wechaty/wechaty.js.org/issues/1045

This PR should follow our rules and get enough approval, then I will review this PR. So I remove the ready to merge tag and feel free to add this tag when it gets enough approval.

@nibble0101 nibble0101 requested a review from chris-4444 July 12, 2021 11:21
@Rohitesh-Kumar-Jain
Copy link
Contributor

@chris-4444 I would like you to once go through the PR, and approve when you think it's ready to get merged.

Copy link
Contributor

@chris-4444 chris-4444 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Copy link
Member

@lijiarui lijiarui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating!

I think the whole file looks good to me, but I suggest we add the link in the page, or file an issue to track this, then adding the issue in the future, or it may cause a dead link in the future.

Also, I file an issue #1089 and looking forward to put the content somewhere in the doc in the future.

docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
docusaurus/docs/overview.mdx Outdated Show resolved Hide resolved
@nibble0101 nibble0101 requested a review from lijiarui July 15, 2021 15:44
Copy link
Member

@lijiarui lijiarui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the change!

@huan huan merged commit 933f7e8 into wechaty:master Jul 16, 2021
@huan
Copy link
Member

huan commented Jul 16, 2021

Thank you very much for all efforts from everyone as a team, appreciate it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GSoD 2021 introduction Pull requests that update introduction section of the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants