Re: [Hydrogen-devel] Help wanted: Documentation / Further documentation plans

[Thijs v. s. <thi...@gm...>]

IIRC the manual is in doc book format to make it translateable
This document is then converted to 1 html document per language


Op 23 mrt. 2017 14:04 schreef <tr...@tu...>:

> Le 2017-03-11 11:35, ma...@sm... a écrit :
> >
> > As you most of you already know, the hydrogen manual and tutorial are
> > getting more and more deprecated since those documents were not updated
> > for some time.. Is there anyone on this list who has an interested in
> > writing and who would be interested in helping with updating the
> > manual?
>
> I am.
>
> > Apart from that, i'm currently thinking about putting the documentation
> > (manual and tutorial) in a separate git repository. This helps to keep
> > the source code repository small (i suppose that over time, more and
> > more larger images will be added to the manual) and allows for a better
> > permission-management for our repositories.
>
> It would be awesome!
> For my personal case, I tried 2 or 3 times to dive in how the manual is
> managed
> into hydrogen, and I failed to understand that, even when reading the
> related docs.
> the way I see how I could work with it should be as follow :
> - editing the files through the github interface within a fork
> - saving them trough the github interface
> - building Hydrogen from my fork
> - checking that what I did is right and well done
> - submitting a patch against the Hydrogen repo
> - done
>
> If something like that could be achieved, it would allow me to spend
> more time
> in helping with the manual, keeping it up to date, adding the new
> functionnality,
> adding stuff asked and answered in the forum but not in the manual yet,
> ...
>
> BTW : lately some developers have been starting to put some information
> with there
> pull request (see https://github.com/hydrogen-music/hydrogen/pull/359 or
> https://github.com/hydrogen-music/hydrogen/pull/356 for examples) and I
> think that
> it is really really great. Thanks people ! I'd be glad to be useful in
> integrating
> those info into the manual.
>
> Cheers,
> Olivier
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Hydrogen-devel mailing list
> Hyd...@li...
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
>