17
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
m
Jetpack/SDK/Writing Documentation (view source)
Revision as of 20:14, 18 August 2010
, 18 August 2010→Writing Documentation with the Add-ons Builder SDK
| Line 1: | Line 1: | ||
== Writing Documentation | == Writing Documentation for the Add-ons Builder SDK == | ||
Documentation in the Jetpack SDK is a self-contained system within the SDK itself. All of the documentation is generated on the fly, via actual files located in the directory structure and viewable either as source or as a web page after the SDK has been activated and the "cfx docs" command has been run from the command line. | Documentation in the Jetpack SDK is a self-contained system within the SDK itself. All of the documentation is generated on the fly, via actual files located in the directory structure and viewable either as source or as a web page after the SDK has been activated and the "cfx docs" command has been run from the command line. | ||
| Line 6: | Line 6: | ||
The "cfx docs" command launches a small web server in order to render the documentation for human consumption. It relies on three things: | The "cfx docs" command launches a small web server in order to render the documentation for human consumption. It relies on three things: | ||
* That the documentation is written in Markdown syntax | * That the documentation is written in Markdown syntax | ||
* That the API component is written in APIDocs syntax | * That the API component is written about in APIDocs syntax | ||
* That there are corresponding .js/.md files in the lib/docs directories | * That there are corresponding .js/.md files in the lib/docs directories (e.g. tabs.js/tabs.md) | ||
All documentation for Jetpack(s) can be written following those three principles. | All documentation for Jetpack(s) can be written following those three principles. | ||