On Fri, 2 May 2025 at 09:52, souleymane conté
<conte.souleym...@gmail.com> wrote:
> I am interested in contributing to the QEMU project. I would like
> to begin by working on the task described in Issue #527 on GitLab:
> https://gitlab.com/qemu-project/qemu/-/issues/527.
>
> The task involves Plain text files in docs/ should be converted to rst:
>
> docs/igd-assign.txt
> docs/image-fuzzer.txt
>
>
> I would appreciate it if you could confirm that this task is still available 
> to work on.

Hi; yes, this task is still available to work on. We've been
gradually converting the remaining text files in docs/ to RST,
but there are still some left, including the two you list.

I would note that as we've done the conversions we've mostly
done the easier ones first, so the files that are left are
getting a bit trickier to do. In particular, anything in docs/
needs not just to be converted in format, but also it needs
to live in the correct sub-part of the manual (system/,
devel/, interop/, etc), and sometimes a single txt file
combines information that needs to be split into several
different places.

If you don't mind which docs you're looking at, these two
are simple format conversions that are already in the right
place in the manual and don't need splitting up:
  docs/interop/qcow2.txt
  docs/interop/qed_spec.txt
(You can look at other files in that directory and at the commits
in the git history that converted them from txt to rst to get
ideas on how to handle some of the things like ASCII art diagrams
and tables.)

Of the two files you list, I think docs/image-fuzzer.txt can
probably reasonably become docs/devel/image-fuzzer.rst without
needing to be split up. docs/igd-assign.txt is a bit trickier,
but I think most of the content belongs somewhere under system/.

thanks
-- PMM

Reply via email to