Jump to: navigation, search

Difference between revisions of "Orion/Documentation"

Line 1: Line 1:
Orion documentation will initially be developed on the eclipse wiki. This page will provide some resources for authoring that documentation.
+
Orion documentation is authored primarily on this wiki. This documentation is then converted into standalone HTML documentation in the build using [[Mylyn/WikiText]]. All child pages of this page are included in Orion builds. This documentation is held to a higher standard than typical Eclipse wiki content. The following rules must be followed:
 +
* Do NOT move or rename any of these pages without updating the corresponding build script.
 +
* Follow the style guidelines in the [[Eclipse Doc Style Guide]].
 +
* Documentation must remain up to date with current features in origin/master in our Git repository.
 +
* Only include documentation for fully implemented features. Do not include design plans for future feature work, or other transient developer documentation.
  
== References between documentation sections ==
 
  
* Template for references to jsdoc
+
== TODO ==
* Template for references to server doc
+
 
 +
* How to reference jsdoc from the documentation
 
* References within jsdoc use @link
 
* References within jsdoc use @link
 +
* Recommended Usage of JSDoc
  
== Recommended Usage of JSDoc ==
+
[[Category:Orion|Documentation]]
 
+
 
+
 
+
[[Category:Orion|Writing documentation]]
+

Revision as of 10:19, 10 May 2011

Orion documentation is authored primarily on this wiki. This documentation is then converted into standalone HTML documentation in the build using Mylyn/WikiText. All child pages of this page are included in Orion builds. This documentation is held to a higher standard than typical Eclipse wiki content. The following rules must be followed:

  • Do NOT move or rename any of these pages without updating the corresponding build script.
  • Follow the style guidelines in the Eclipse Doc Style Guide.
  • Documentation must remain up to date with current features in origin/master in our Git repository.
  • Only include documentation for fully implemented features. Do not include design plans for future feature work, or other transient developer documentation.


TODO

  • How to reference jsdoc from the documentation
  • References within jsdoc use @link
  • Recommended Usage of JSDoc