Re: Project Documentation Workflow

[Simon Tournier <zimon.toutoune@gmail.com>]

Hi,

On Fri, 01 Sep 2023 at 10:18, Peter Polidoro <peter@polidoro.io> wrote:

> I could solve this using Git tools, such as submodules or subtrees 
> perhaps. I could have a repository that is the documentation 
> skeleton and each project repository would have a reference to 
> that skeleton repository. Then I would probably need to write some 
> script to combine the local project files with the skeleton files 
> to generate the specific project documentation.

Well, from my understanding, you are describing a specific build system
for your documentation. :-)

> I am wondering if a better approach might be to create a Guix 
> package containing the documentation skeleton and each project 
> inherits that package and applies local changes before generating 
> the project documentation. I have not yet used Guix home, but 
> perhaps that can be used for projects as well as home directories 
> for such tasks?

Yeah, maybe having these documentation for each project as Guix
packages, you could share the common build system (script for building
the documentation) and inherit from one package to the other depending
on these projects.

Well, I have never needed to build many documentation. :-)


Cheers,
simon