[DOC] Edit for readability and grammar

refinedev / refine

A React Framework for building internal tools, admin panels, dashboards & B2B apps with unmatched flexibility.

https://refine.dev

MIT License

26.05k stars 1.97k forks source link

[DOC] Edit for readability and grammar #5893

Open clairestovall opened 2 months ago

clairestovall commented 2 months ago

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.

aliemir commented 2 months ago

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 commented 2 months ago

Hey @clairestovall any updates?

clairestovall commented 2 months ago

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

stale[bot] commented 6 days ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.