[Fusionforge-general] Partial report of the FusionForge meeting
Alain Peyrat
aljeux at free.fr
Tue Oct 16 17:23:22 CEST 2012
On 16/10/2012 15:36, Olivier Berger wrote:
>
> If I'm not mistaken, we somehow agreed to drop the "manuals" like
> documentation (the one in docbook format under
> ./src/docs/docbook/docbook...) and use the wiki instead.
>
> Any objections / comments / suggestions ?
I'm quite worry about this change for the following reasons:
1) The wiki is a mess. It's nearly impossible to find something inside
and it's current content does not match the user guide. Dropping the
docbook would means removing the little help that we have.
2) We rely on the online_help plugin to provide a contextual help for
users. The documentation provided is given by converting the docbook
format in HTML pages (one per tool).
3) Having the documentation aligned with the source code is the best way
to get a documentation aligned with the features.
But, on the other side, I must admit that nearly nobody is updating the
docbook. My feeling is that it's partly related to the docbook format
which is not so sexy. Would a switch to a simplier format like markdown
or sphinx could help?
Alain
More information about the Fusionforge-general
mailing list