Create technical documentation

[GoogleCodeExporter]

There is an urgent need for technical documentation that gives users and site 
managers an easy manifest on how tom implement and configure the geoext-viewer. 
Enduser documentation is outside the scope of the geoext-viewer and should be 
managed by the parties that create derived work.

Original issue reported on code.google.com by milovand...@gmail.com on 4 Apr 2011 at 7:54

[GoogleCodeExporter]

Openlayers uses NaturalDocs to generate technical documentation from 
comment-blocks within the code. I would advice to follow a similar pattern as 
it will be easiest to maintain the documentation from within the code.

Original comment by milovand...@gmail.com on 4 Apr 2011 at 7:55

[GoogleCodeExporter]

Original comment by jus...@gmail.com on 20 Apr 2011 at 11:51

• Added labels: Project-RVOB3

[GoogleCodeExporter]

Original comment by jus...@gmail.com on 12 May 2011 at 2:19

• Added labels: Milestone-Release0.5

[GoogleCodeExporter]

Issue 34 has been merged into this issue.

Original comment by jus...@gmail.com on 23 May 2011 at 9:35

[GoogleCodeExporter]

For release 05. We will create the general framework to generate the 
documentation, both the API docs from the code (ala OpenLayers and GeoExt using 
NaturalDocs or something similar) and the overall User/Developer doc setup 
possibly using Sphinx.
It is the intention to use the website www.heron-mc.org as the starting point. 
The Google code Wiki will not be extended, as we may move completely away at 
some later stage.

Original comment by jus...@gmail.com on 23 May 2011 at 9:39

• Added labels: Priority-High
• Removed labels: Priority-Medium

[GoogleCodeExporter]

Also on advise from Bart and the use of Sphinx in GeoExt and GXP I will setup a 
Sphinx documentation for both regular docs as well as the API (via JST 
template).

Original comment by jus...@gmail.com on 24 May 2011 at 7:36

• Changed state: Started

[GoogleCodeExporter]

The doc overall framework is there. We still need to fill the API doc (thourhg 
JS comments) and some primer docs. I'll keep this open so the work is not 
forgotten.

Original comment by jus...@gmail.com on 31 May 2011 at 1:23

• Added labels: Milestone-Release0.7
• Removed labels: Milestone-Release0.5

[GoogleCodeExporter]

Ok let's put this in 0.6 and make (a) new ticket(s) that makes remaining doc 
work explicit. Everything is there on http://heron-mc.org

Original comment by jus...@gmail.com on 31 May 2011 at 1:39

• Changed state: Fixed
• Added labels: Milestone-Release0.6
• Removed labels: Milestone-Release0.7