Plain text files in docs/ should be converted to rst
At the moment the docs/ subdirectory includes a lot of files which are in plain text format (you can get a list with find docs -name '*.txt'
). None of these files are shipped to our end-users; they all need to be converted into rST format so that they form a part of our HTML manuals.
Text files in one of the subdirectories devel
, interop
or specs
should be straightforward -- they are already in the right place, and generally only need to be converted to .rst files and added to the table of contents in the appropriate index.rst
file. These are good "bite sized task" candidates. (Suggestion: do one at a time to check you have the right approach.)
Text files in the top level docs
directory are going to be trickier to convert. These are generally older documents, and they often mix together information for developers, specification information and end-user documentation in the same file. These are better tackled by somebody who understands the relevant parts of QEMU, because the right approach for these files is often going to be to split out different parts of the contents into multiple new files in different parts of the HTML manual.