search

oicr-ibc / heliotrope

Other
10 stars 0 forks source link

Add appropriate documentation #5

Closed morungos closed 10 years ago

morungos commented 11 years ago

Both the front end and the back end deserve better documentation. The knowledge base building has some embedded pod. How best to do this remains an open issue. In an ideal world, we could do a CoffeeScript style watch (and CS handles Literate fine anyways). That's for the source. Better DB and related documentation is an independent issue.

morungos commented 11 years ago

Two things seem to help. for the service, we can use doxx, but we'll need to add that to the Cakefile some time. For the front end, Literate CoffeeScript works well. The two approaches are different, however, and some consistency would be nice. Literate JavaScript is one option (we'd need to include that in the service build) and doxx can also work on CoffeeScript. Whatever we do does need to work well with AngularJS, though.

morungos commented 10 years ago

Using literate CoffeeScript seems best, as we don't need to do any changes to the build process. it simply works within Github directly.

morungos commented 10 years ago

Completed port to literate CoffeeScript in d3b947f