CANopenEditor icon indicating copy to clipboard operation
CANopenEditor copied to clipboard

[MIX][DOCS] Improving global documentation

Open reza0310 opened this issue 2 months ago • 4 comments

This PR will be my work-in-progress documentation of the project to solve issue #189. I open it now so anyone can give me insights on my changes while I work on them and everyone can easily follow my work.

Rewrote most of root README.md and wrote CONTRIBUTING.md and every other READMEs. Changes are meant for easier understanding of the project by anyone and better integration of and communication with new contributors. Those changes being purely textual, no tests where made for now but I intend to pass the text through an orthographic corrector once done.

Resolves #189 Discussions are done on #189

I have read the contributing guidelines, I agree to following them and I agree to the Developer's Certificate of Origin 1.1

reza0310 avatar Oct 21 '25 13:10 reza0310

Not sure exactly what this is, but would not a issue be better?

nimrof avatar Oct 21 '25 14:10 nimrof

There is an issue ;). It's issue #189. This is my WIP suggestion to solve the issue.

reza0310 avatar Oct 21 '25 15:10 reza0310

If the name (of the PR) is problematic, I have to admit I wasn't very inspired any suggestion is welcome.

reza0310 avatar Oct 21 '25 15:10 reza0310

There is an issue ;). It's issue #189. This is my WIP suggestion to solve the issue.

Ahh, Could you link it with the issue? linking a pull request to an issue

If the name (of the PR) is problematic, I have to admit I wasn't very inspired any suggestion is welcome.

Its not problematic until someone merges it without changing the name :), but please change it to something that is more describing of what you are changing/fixing Just 'improving documentation' is enough

Thanks again

nimrof avatar Oct 21 '25 15:10 nimrof

Documentation is something I didn't pay attention to in this project. So, great job. If you need my comments, please let me know.

Janez

CANopenNode avatar Nov 19 '25 09:11 CANopenNode