T
T
Traveler2015-05-24 21:10:45
Documentation
Traveler, 2015-05-24 21:10:45

Where is the best place to document an Open source project?

Good afternoon!
I am running a small Open Source project on github. Initially, the instruction was placed in readme.md. Now we need to write more detailed documentation. I originally planned to use the github wiki for this, but I rarely see other projects using it. There is a readthedocs.org service. Maybe there are other free services.
The question is, where is it better to place the documentation, what would be more convenient for users? What are the pitfalls?

Answer the question

In order to leave comments, you need to log in

2 answer(s)
D
Daniil Kolesnichenko, 2015-05-24
@KolesnichenkoDS

Github allows you to host statics: https://pages.github.com
You can choose a template and write MD, you can edit the HTML yourself. There are also all sorts of statics generators from CMS, you can work with CMS on your computer and throw statics there.

D
Dan Ivanov, 2015-05-27
@ptchol

You can write to these guys here https://readme.io , they say that it's free for open source.
There is also https://apiary.io if you have some kind of api, it might be better suited.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question