Jetpack/SDK/Writing Documentation: Difference between revisions

Jetpack/SDK/Writing Documentation (view source)

1,079 bytes added , 18 August 2010

17

edits

@@ Line 60: / Line 60: @@
 As you continue developing with the Add-ons Builder SDK, you may want to include documentation with your own modules.
-*file structure
+Documentation for core Jetpack modules and custom libraries can be found when you run "cfx docs" after activating the source. "cfx docs" launches a browser window where the documentation is viewable.
-*.md file corresponds to the .js file
-*APIDocs and code example
+In the jetpack-sdk/packages/<your module> directory, you can include a file called README.md. This file may contain some high level-level information about the package. The README.md and package.json files will generate a well formatted page that contains an overview of the package.
+[http://img.skitch.com/20100818-raumdbfmwytkf9qd26sg251a82.jpg documentation example]
+Below the module on the left column is a list of the component modules, as built from the .js files in the jetpack-sdk/package/<your module>/lib directory. When you click on the name of the *lib*, the corresponding .md file in the docs directory is opened in the right column.
+The custom documentation should be in Markdown format, and for the stake of standards, should have the following:
+* API definition in the APIDocs format as indicated above
+* Some small example to illustrate the use of the code in context
+Questions and comments can be directed to the google groups for Jetpack.