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.

Sign up for GitHub

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

Jump to bottom

Rewrite documentation #283

Open
nrkramer opened this issue May 10, 2023 · 5 comments
Open

Rewrite documentation #283

nrkramer opened this issue May 10, 2023 · 5 comments
Assignees
@kamari-a
Labels
documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest hacktoberfest issue help wanted Extra attention is needed Priority:Low Priority Label for low priority issue

Comments

@nrkramer
Copy link
Collaborator

nrkramer commented May 10, 2023 •
edited
Loading

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.
@ZigRazor ZigRazor added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed Priority:Low Priority Label for low priority issue labels May 10, 2023
@kamari-a
Copy link
Contributor

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?

@ZigRazor
Copy link
Owner

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

@nrkramer
Copy link
Collaborator Author

@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!

@ZigRazor
Copy link
Owner

ZigRazor commented Jul 4, 2023

@kamari-a any news?

@kamari-a
Copy link
Contributor

Hi @ZigRazor and @nrkramer! Sorry for the delay while I was on holiday. I've just opened a draft PR: #329

@ZigRazor ZigRazor added the hacktoberfest hacktoberfest issue label Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kamari-a kamari-a

Labels
documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest hacktoberfest issue help wanted Extra attention is needed Priority:Low Priority Label for low priority issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nrkramer @ZigRazor @kamari-a