RubyGems with documentation, source code and API documentation?

Question

I was wondering why so many coders have poor organization in their documents.

I think I know why.

As usual, this is due to standardization. If there is no standard, everyone should reinvent the wheel all the time.

So, I upload the gem to RubyGems.org. But this is only 1/4 of everything.

• I need to write a tutorial for this, creating categories, text style, size, color, etc.
• I need to create API documentation from my code
• I have to put it in a git-hub (never done this, but should it be right?)

This is a painful process.

It would be great if every pearl followed the same documentation structure. You upload your gem, you write documentation for it that everyone can edit, API documentation has also been generated, can be created automatically if you provided information to your account, for example.

Good process.

I think this would enhance good cooperation and the environment than each stone has its own structure (poor documentation) and placing the API documentation here and there.

Do you disagree?

Answer 1

This type of documentation (a textbook, not a created document, ...) is better addressed to the wiki.

.
GitHub -.
GitHub ( GitHub , Jekyll Makdown)

Answer 2

, . , , . , . , , , , .

!