Documentation proposal

Brian J. Tarricone brian at tarricone.org
Mon May 4 10:07:48 CEST 2009


On Mon, 4 May 2009 08:39:56 +0200 Nick Schermer wrote:

> Previously I was thinking a separate package for docs was a good idea,
> but noadays I'm more or less against this (because of the modularity
> it should be possible for people to use a single component without
> being bothered with the rest of the documentation).

Yeah, that was my main issue as well.  Some people do use xfwm4 (for
example) outside of Xfce, so installing *all* of the Xfce docs just to
get xfwm4 docs might be silly.

> On the other hand I can understand all the docs in a single repo are
> easier to maintain, which is at this point the biggest issue. So maybe
> we can put all the docs in 1 git module and we use a hook inside a
> module (thunar, panel, xfwm4) to include the (translated) html when
> running make dist.

Something like that... only maybe better might be to -- as you say --
have all the docs in one git repo, but still distribute them in each
app module as we do today.  Should be simple to do with git submodules,
right?  That way people who want to improve the docs only need to look
at one module, but the docs still end up in each individual module for
distribution.

	-brian



More information about the Xfce4-dev mailing list