search

chevah / geck

Chevah Garden Of Eden Creation Kit
http://geck.chevah.com/
0 stars 1 forks source link

Describe how we should handle the documentation part of the project #26

Closed adiroiban closed 7 years ago

adiroiban commented 8 years ago

Scope

This tries to add an initial few ideas and notes about how we should document the project.

from technical docstrings, to end user documentation to marketing materials

if we would have to start this project from zero and we would all have our project related info erased, this document should include all common knowledge and best practices that we have found while working on the project.

Changes

For now, there is just a structure

How to try and test the changes

reviewers: @alibotean @brunogola @atykhonov @lgheorghiu @dumol

I have just pushed an initial page structure.. if know know what we can put here, please push your changes :)

Thanks!

adiroiban commented 8 years ago

In the following days I will try to add more info here... but meanwhile if you know what should be here, please contribute.

Thanks!

hcs0 commented 7 years ago

Just noticed this PR which is similar to what I have in mind for https://github.com/chevah/styleguide/issues/44 :) I think it's better to start a-new in case there has been some changes from the styleguide since then (plus there is a Trac ID associated).

adiroiban commented 7 years ago

@hcs0 Thanks. yes. is ok to have a new one. Please consider including the tentative section from this PR so that this PR can be closed as duplicate.

hcs0 commented 7 years ago

Closing due to duplicate of https://github.com/chevah/styleguide/tree/3858-documentation