Author avatar for jason

Documentation for SugarCRM Modules

Posted by on January 24, 2013

One of the many perks we offer to any add-on that lists on SugarOutfitters is an easy to use documentation platform. In fact, we use that same system for our own documentation. The markup language that is utilized is an enhanced, SugarOutfitters version of Markdown Extra. Markdown is a lightweight markup language that is easy to read and write using just plain text. A parser then converts that into a slightly more beautiful HTML version.

What this means is that it makes it really easy for developers to create good looking, easy to read documentation for their modules. Using our version of Markdown it is easy to create lists, format text, embed images, or add headers.

For more complex formatting, inserting straight html is always an option. This makes it easy to take YouTube’s embed code and putting it into a doc. It can also be used to create more advanced tables such as feature comparison grids.

In addition to these formatting options, pages can be easily reordered by drag and drop.

There is also a comment system that makes it easy for members to add feedback, get clarification, etc. Whenever a comment or reply is made all involved parties get an email with a summary of the conversation.

Go ahead, give it a try. But before you do make sure to upload an avatar. It will look better than the default avatar shown above.