[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: QEMU participation to Google Season of Docs
From: |
Peter Maydell |
Subject: |
Re: QEMU participation to Google Season of Docs |
Date: |
Mon, 6 Apr 2020 11:57:11 +0100 |
On Mon, 6 Apr 2020 at 11:35, Paolo Bonzini <address@hidden> wrote:
> On 04/04/20 03:37, John Snow wrote:
> > 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.
Yep, and unlike last year we've actually (almost) completed
the transition to Sphinx so we have a workable structure/tooling
for a tech writer to work with.
thanks
-- PMM