Extension, Module

EE 1
EE 2
Dev Docs

Developer

Focus Lab, LLC - Erik Reagan

3rd Party (Free)

Compatibility

  • LG Addon Updater
  • Multi Site Manager
  • Stand Alone Entry Form

Requirements

  • jQuery for the Control Panel

Tags

Dev Docs was born from a desire to have project-specific, developer-based documentation available within a site's Control Panel.

At Focus Lab we have a file in each project’s repository root that is meant only for developers. This file is in Textile formatting (like this readme file) and is meant to be the primary source of information to get “up to speed” on the project. You can learn more about our documentation practices in “our documentation article on EE Insider”:http://eeinsider.com/articles/the-dreaded-documentation/.

Dev Docs will parse the Textile-formatted documentation file into a multi-page Control Panel experience. Each “page” is determined by each “h1. Title” section of the document. The documentation is cached in the database to speed up page loads while reviewing the docs. If the documentation ever gets updated, the cache is automagicaly cleared and the docs are updated in the database.

Dev Docs Links

This entry was last updated November 2, 2011, 3:12 am.

Disclaimer: Information about ExpressionEngine add-ons is provided as a service to you, the user, and every member of the ExpressionEngine community. Devot:ee is not responsible if you hose, mangle, wreck, or otherwise destroy your EE website by installing an add-on that you found out about at this site, regardless of its rating, Favorites status, commercial or free status, or general popularity. Caveat EEmptor!

1 Review:

enviromed 11.02.11

enviromed
Rating - {addon_rating_average}

Terrific!  Thanks Eric