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

[DOC] Edit for readability and grammar #5893

Open
clairestovall opened this issue Apr 25, 2024 · 3 comments
Open

[DOC] Edit for readability and grammar #5893

clairestovall opened this issue Apr 25, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@clairestovall
Copy link

clairestovall commented Apr 25, 2024

Documentation issue

Refine's documentation could benefit from improved grammar, clarity, and consistency.

Describe the thing to improve

  • Oxford comma usage is inconsistent across the documentation
  • Removal of comma splices
  • Simplified language for a global audience, such as when referring to examples in-line
  • Minor grammatical and formatting issues

Describe the solution (optional)

Using the Google Style Guide and Microsoft Style Guide, I will propose fixes to resolve the above items.

@clairestovall clairestovall added the documentation Improvements or additions to documentation label Apr 25, 2024
@aliemir
Copy link
Member

aliemir commented Apr 25, 2024

Hey @clairestovall, thank you for the issue! We look forward to seeing your PR. Updating our documentation according to the feedbacks we've received was on our list for the next sprints. I'm hoping your PR will also improve our docs for the better 🚀

@BatuhanW
Copy link
Member

BatuhanW commented May 2, 2024

Hey @clairestovall any updates?

@clairestovall
Copy link
Author

Hey @BatuhanW - hoping to get to this weekend. Do you know the specific feedback from users that @aliemir mentioned?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants