CXXGraph icon indicating copy to clipboard operation
CXXGraph copied to clipboard

Published 20 hours ago • verified publisher icon ZigRazor

Rewrite documentation

Open nrkramer opened this issue 2 years ago • 5 comments

At some point, we should rewrite/update the documentation (in both headers, and the README) to be grammatically correct English that is clear and concise.

This issue isn't meant to insult anyone's English, it's just meant to give the project a more professional polish, as I know many of the contributors here don't use English as a first language.

nrkramer avatar May 10 '23 03:05 nrkramer

Hi @ZigRazor and @nrkramer! I'm working on improving my technical writing skills by contributing towards open source documentation and came across CXXGraph. I'd love to help update the README documentation to be more concise if this issue is still open?

kamari-a avatar May 25 '23 17:05 kamari-a

Yes, @kamari-a the issue is still open!

ZigRazor avatar May 25 '23 17:05 ZigRazor

@kamari-a Kamari, if you'd like to take this task on - please assign it to yourself. Feel free to open a draft PR and push work to it as you go!

nrkramer avatar May 27 '23 20:05 nrkramer

@kamari-a any news?

ZigRazor avatar Jul 04 '23 13:07 ZigRazor

Hi @ZigRazor and @nrkramer! Sorry for the delay while I was on holiday. I've just opened a draft PR: https://github.com/ZigRazor/CXXGraph/pull/329

kamari-a avatar Jul 12 '23 22:07 kamari-a