Jetpack/SDK/Writing Documentation: Difference between revisions

Documentation in the Jetpack SDK is a self-contained system; it is dynamically built based on the files contained within the structure of the SDK. The javascript lives in jetpack-sdk/packages/<package-name>/js the corresponding documentation lives in jetpack-sdk/packages/<package-name>/docs. As long as the prefix for the .js and the .md files is the same, the documentation will be generated and viewable via the "cfx docs" command.  

APIDocs This has roots in the JavaDocs format for documenting APIs within the structure of the Java code itself. The idea was to make it functionally similar to document APIs within the code as well as provide a way to give a framework for documenting the API in a human-readable format. [reference a JavaDocs site]  

     Properties

Further examples can be found in the jetpack-core/docs directory.  

Found something that we're missing? Bugs? Additions? In order to contribute to the jetpack-core docs, please follow the following process to get your changes submitted successfully.  

5. When the change is approved, it will be submitted to the trunk by an appropriate engineer.  

As you continue developing with the Add-ons Builder SDK, you may want to include documentation with your own modules.