Hacker News new | ask | show | jobs
by cygned 3198 days ago
Would love to see the code documented with docco, like so: http://dak0rn.github.io/prunk/

The whole library would be documented on one page which is a fairly low entry barrier for new developers. Thanks for this awesome project!

2 comments

I like this approach a lot, especially as implemented in [1].

Perhaps a tutorial, or some examples can be documented in that style. Hyperapp + hyperscript-helpers[2] is my favorite combo at the moment.

1. http://dave.kinkead.com.au/modelling-the-boundary-problem/

2. https://github.com/ohanhi/hyperscript-helpers

That would be so nice! I am working on a "how it works" post, but it's still not finished.

If you are interested have a look here:

https://gist.github.com/jbucaran/8dc33b7947f3193eb2ea3d5700e...

Neat! The great thing about docco is that it takes the comments right from the source and creates that page out of it. So you have both a pretty website and the same documentation directly in the code.