Re: QEMU participation to Google Season of Docs

[Paolo Bonzini]

On 04/04/20 03:37, John Snow wrote:
> This looks like it could be very good for us.
> 
> My only concern is that the scope and breadth of QEMU is huge and it may
> be a lot for a newcomer to tackle appropriately for top-level docs, so I
> feel like it requires a mentor who has a good understanding of the broad
> picture of QEMU.
> 
> Like the description says, we often write things bottom-up in areas of
> very specific focus. The broad picture is sometimes harder to conjure
> accurately.
> 
> I have a lot of opinions and thoughts on python and how docs should be
> laid out, but I'm afraid I'm not so good at understanding all of the
> options and "use cases" of QEMU to confidently lay out a top-level TOC.
> Maybe if we collaborated on a TOC we could give a clear project
> guideline to a GSoC/GSoD contributor.

That's actually how a good technical writer can help us!  The main
problem we have with our docs is the disconnect between docs/system
(formerly qemu-doc) and the .txt files in docs/.  We know the material,
but it's hard to reorganize docs/system to make room for everything else.

Reorganizing the TOC to fit all the material in both categories would be
the best outcome of our participation in GSoD.

Paolo