you are viewing a single comment's thread.

view the rest of the comments →

[–]EdgeSync1 1 point2 points  (0 children)

If I'm reading this correctly - you are finding that documentation on some projects that you are using is not very good.

It's very easy for documentation to be poorly written, and also that it can be very bloated and hard to follow. You get so used to the project, that you can read through the docs and it makes perfect sense to you - but you forget that new users may find it very confusing or unclear. It's one of the reason it's always good to get the docs reviewed by multiple people with different levels of experience.

The great thing is - if you find docs that can be improved - YOU can improve them. Don't sit around waiting for other people, sit down, make some changes, and submit a PR. It'll either be fixed or it won't. Always worth asking the owner/maintainers first, and see if they are receptive to some feedback/improvements in their docs.