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

Update README.md #539

Closed
wants to merge 1 commit into from
Closed

Update README.md #539

wants to merge 1 commit into from

Conversation

mukulchugh
Copy link

Proofread the readme file and corrected the grammatical errors and spelling.

Thanks for contributing!

  • If you are making a significant PR, please make sure there is an open issue first
  • If you're just fixing typos or adding small notes, a brief explanation of why you'd like to add it would be nice :)

If you are contributing to README.md, DON'T. README.md is auto-generated. Please just make edits to the source inside of /docs/basic. Sorry, we get that it is a slight pain.

Proofread the readme file and corrected the grammatical errors and spelling.
@filiptammergard
Copy link
Collaborator

filiptammergard commented Aug 15, 2022

Hey @mukulchugh! Thanks for taking the time to go through this. However, as the PR template says, README.md is auto-generated based on /docs files. Can you make the changes there instead and then run yarn gen-readme?

@mukulchugh
Copy link
Author

Sure will do that. :)

Copy link
Member

@eps1lon eps1lon 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 work! However, the readme is generated from individual files in the docs/ folder. Could you apply the changes there instead and make sure you're using Prettier for formatting?

@mukulchugh mukulchugh closed this by deleting the head repository Sep 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants