Documentation for the project needed
theroys opened this issue · 4 comments
Like all other Open source projects we need to create a documentation for for OSSRank.
I would suggest it to be done in asciidoc , and put it in a extra directory called documentation.Which will server as our documentation repo.
Markdown as part of each component?
Markdown is easiest for GitHub projects, as to the location you could place them in a local directory, the project Wiki, or both...
Should we each write a md file describing our portions of the project which
we can then combine into one file?
On Wed, Apr 29, 2015 at 9:05 AM, tjmcs notifications@github.com wrote:
Markdown is easiest for GitHub projects, as to the location you could
place them in a local directory, the project Wiki, or both...—
Reply to this email directly or view it on GitHub
#41 (comment).
I suggest we should have a generic description of overall idea and the vision.. specifying what we want to achieve and our architecture.Then we can have each section telling its own story.
I really like hanlons wiki.. we can also do the markdown