refinedev/refine

[DOC] Edit for readability and grammar

clairestovall opened this issue · 3 comments

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.

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 🚀

Hey @clairestovall any updates?

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