It already is! The new version of documentation in tinyPM. For those who like to wade through the jungle we left the good old one here. The brand new, more civilized edition, equipped with intuitive menus, which we have prepared using Grails, is available here (www.tinypm.com/docs/guide). We changed the design to a more modern, transparent and consistent color.
Fast but not furious
Previous documentation of tinyPM had a one continuous layout. The new one has a division into sections. It’s easier to navigate as well thanks to the added menu, always displayed on the side. The documentation includes a description of:
- how to create an account in tinyPM (www.tinypm.com/docs/guide/start.html),
- how to install tinyPM on the server (www.tinypm.com/docs/guide/on-site-installation.html),
- description of the tinyPM’ structure (www.tinypm.com/docs/guide/structure.html)
- and other topics…, and many more :-)
From Grails with love
The documentation is generated using the standard mechanism of Grails to create the documentation for the application. Check it out here: grails.org/doc/latest/guide/single.html#docengine. We adapted it to the very great needs of tinyPM to work on our own templates and css styles. The result? A completely different look, and underneath the same syntax wiki for quick and easy creation of documentation.
How do you like it? Are there any gaps, lacks or mistaken attacks? :-)