[MIX][DOCS] Improving global documentation #194
Conversation
Starting my redocumentation by correcting some typos I missed, rephrasing some hard-to-understand phrases and aligning lines of the README with how we want them to appear for easier reading (and as such editing) of the raw version.
|
Not sure exactly what this is, but would not a issue be better? |
|
There is an issue ;). It's issue #189. This is my WIP suggestion to solve the issue. |
|
If the name (of the PR) is problematic, I have to admit I wasn't very inspired any suggestion is welcome. |
Ahh,
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 Thanks again |
reza0310
changed the title
Using the online github editor to check in real time how it renders.
trojanobelix
left a comment
trojanobelix
left a comment
There was a problem hiding this comment.
Looks good to me.
... "dictionary for CANopenNode (CO_OD.c and CO_OD.h)"... might be change to e.g.
"dictionary for CANopenNode (V1.3 and newer)" , because it can also create OD.h and OD.c for V4 of the stack (not only CO_OD.*)
also in this line (and maybe others):
"Export C and H files in CANopenNode format CO_OD.c and CO_OD.h"
reza0310
changed the title
Also put in it trojanobelix's suggestion
nimrof
left a comment
nimrof
left a comment
There was a problem hiding this comment.
Mostly just suggestion and some typos/fixes
Feel free to counterargument
|
|
||
| ## Discussions | ||
| Discussions shall be done in respect to everyone and everyone's work. | ||
| Any major change shall be first discussed in an issue. Do not worry: maintainers are quite active and will answer. |
There was a problem hiding this comment.
maintainers are quite active 😶
There was a problem hiding this comment.
Well that's what I think <3. Are other open source projects of this size more active ?
There was a problem hiding this comment.
Well that's what I think <3
That is good news
Are other open source projects of this size more active ?
Good point about the size, and not sure tbh :)
There was a problem hiding this comment.
Well that's what I think <3
That is good news
Are other open source projects of this size more active ?
Good point about the size, and not sure tbh :)
It seems, we are currently four quite active. Each with own skills. Although I'm mot sure, if you will be happy with my habits. I'm currently quite excited about .net10 and about idea to start from scratch and combine ideas an code we have into fresh project (just git branch). But slowly.
Applying nimrof's corrections Co-authored-by: Lars Elgtvedt Susaas <[email protected]>
Some paths were wrong, I used the online previewer to check them thoroughly
|
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 |
trojanobelix
left a comment
trojanobelix
left a comment
There was a problem hiding this comment.
That's fine with me.
Thank you very much for your contribution.
4 participants
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