Re: [Hydrogen-devel] H2 manual

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

Hi Phil, thanks for the feedback!

Are you talking about the user manual or about the coding documentation?

I'm talking about the user manual. Things like pEngine dont belong there
IMHO.  Or am i missing something here?

Some way to auto-push the content of the git repo to the website would
indeed be handy.  I remember that (a looong time ago) we were thinking
about ways to generate a pdf version of the manual so that this pdf could
then be bundled with H2 as separate document.
IIRC the manual is now part of the H2 application so a usr cannot update it
to the latest version without upgrading the complete application.

Maybe we could even include an automatic 'check for updated manual' when H2
starts and if an updated manual is available (for the H2 version that the
user is running!!) the user can be notified and given the option to
download this new version

Grtz
Thijs


Op ma 6 mei 2019 09:43 schreef Philipp Müller via Hydrogen-devel <
hyd...@li...>:

> Hey Thijs,
>
> On 06.05.19 08:32, Thijs van severen wrote:
> >
> > I'm thinking about possibly considering to maybe get started on
> > updating the manual ;-)
> +1
> > Before i dive in : is the howto doc on the site up to date? Anything
> > else i need to know ?
>
> I think it would be a good idea to use some continuous integration to
> automatically push updates of the documentation to the website.
>
> I'm not quite sure how it is served right now but since there is already
> a dedicated [git repo](https://github.com/hydrogen-music/hydrogen-music)
> and the website is static, we could use Github Pages.
> This way we could simply include the repo of the documentation as a
> submodule and use the latest version. I'm not a 100% sure if one can
> trigger Travis to process one repo (web page) when pushing to another
> (doc) but there's probably a hook for that.
>
> What I really want to do is to get the naming of the Hydrogen and
> AudioEngine straight and consistent and possibly also reflect it in the
> docs. The former is often called pEngine in the code and it led to quite
> some confusion at my end when first delving into the code. But this
> deserves another thread and I will post a message during next days.
>
> Cheers,
>
> Phil
>
>
>
> _______________________________________________
> Hydrogen-devel mailing list
> Hyd...@li...
> https://lists.sourceforge.net/lists/listinfo/hydrogen-devel
>