Documentation system

Monkey Archive Forums/Monkey Discussion/Documentation system

matt(Posted 2011) [#1]
I'm the creator of the monkey module documentation system. It's a page generator for JSON data formatted in a specific way. Benefits of this approach are: speed, flexibility, smaller data size, the ability to bookmark specific pages, and search through the data locally.

The system is also extensible, in that if you write your own module you can also add your it's documentation to the system! This is shown in the /docs/modules/json-demo.js file. You'll probably want to write some sort of converter to take a text file and spit out JSON, though I'll be writing a simple one at some point.

I hope the modules documentation system makes your monkey experience more enjoyable and feel free to request enhancements in this thread. More importantly, do make sure you post errors in the documentation itself in the Bugs section: http://www.monkeycoder.co.nz/Community/posts.php?topic=54

Thanks!
matt


matt(Posted 2011) [#2]
This is now on github

https://github.com/gingerbeardman/json.docs