Hi. I (newly registered “developer”) am looking for confirmation in the direction of the online doc. It appears that the general developer documentation (as supposed to the happily doxygen-ated package-specific doc) are being migrated from an old system to a new system.
The old system appears to involve plain html “source” files — presumably updated through the bazaar source tree — being prettied up slightly via a pass through doxygen to produce both online documentation and downloadable offline documentation.
The new system appears to be the trac system, updated wiki-style.
Do I understand correctly that this is the intended direction — wiki for general documentation, and continued use of doxygen for what it does best — detailed package source documentation?
If this is the direction, does this mean that the general documentation (e.g. the coding standards document) will only be available for update online through the trac wiki but no longer via normal bazaar check-in?
Will downloadable releases no longer contain these documentation files?
Or will releases contain interlinked static “read only” snapshots of the wiki pages as of the release date?
Or is it possible to transform the static snapshots as they are generated in such a way that they contain a modified “Edit this page.” button — theoreticaly could the static (offline) page’s “Edit this page.” button (after suitable verification and warning) link to the “edit page” for the most current trac online version of the page?
It may be trendy to act like every machine is online 24/7, but I still see a benefit of a reasonably current consistent doc set for use offline on my local machine. Has there been any thought about this?
It’s something I’d like to have settled in my own mind before I start the project of migrating (for starters) the Coding Conventions information into the new Trac page.
Thanks,
–paul
Paul A. Martel
