Notes about Qubes OS documentation(s)
=====================================

Issues
------

Currently working on
^^^^^^^^^^^^^^^^^^^^

* :issue:`Add the community doc "How to open URLs/files in other VMs" to the official docs <8166>` (still a lot to do!)
* :issue:`Be clear about the exact release targeted by the documentation and its status <10263>` (needs review)
* :issue:`Improve the "Command-Line Tools" reference web page <5246>` (needs review, there is more to do but not now)
* :issue:`Remove ads from documentation <10469>` (I need :issue:`an answer from Marek <10469#issuecomment-5078401145>`)
* :issue:`Collect all existing documentation and publish it <11009>`, see also:

  * :issue:`Create a sphinx doc for qubes-builderv2 and put it on RTD <11008>`
  * :issue:`Create a sphinx doc for qubes-app-linux-img-converter and put it on RTD <11007>`
  * :issue:`Create a sphinx doc for  qvm-create-windows-qube and put it on RTD <11006>`
  * :issue:`Create proper sphinx docs for qubes-mgmt-salt and put it on RTD <11005>`
  * :issue:`Create proper sphinx docs for qubes-core-admin-linux and put it on RTD <11004>`
  * :issue:`Create proper sphinx docs for qubes-desktop-linux-common and put it on RTD <11003>`
  * :issue:`Add qubes-video-companion to Read the docs <11002>`

Things to do
^^^^^^^^^^^^

* :issue:`Remove unused code related to :ticket: role in qubes-core-admin dochelpers <10994>`

Issues about the structure / maintainance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* :issue:`Provide a hierarchy in the How-to guides of the documentation <10264>`
* :issue:`Better integration between "How to use devices" pages and "qvm-device" documentation <10601>`
* :issue:`Add a way to review documentation pages <10623>`
* :issue:`Remove duplicated dependencies in qubes-doc <10738>`

Build issues
^^^^^^^^^^^^

* :issue:`Offline documentation <1019>`
* :issue:`Orchestrate documentation build with disposable qube <10327>`

Good ideas
^^^^^^^^^^

* :issue:`User-focused documentation of qubesctl/saltstack <10577>`

Missing parts
^^^^^^^^^^^^^

* :issue:`Document device “self-identity oriented” assignment in user documentation <10600>`

Other things
^^^^^^^^^^^^

* :issue:`Confusing mention of "hard wrap" in the documentation style guide <10221>`
* :issue:`Clarify the "Verifying signature" documentation page to help users following it <10561>`
* :issue:`Visual Style Guide page was not migrated to RST and is not present in RTD <10765>`
* :issue:`Provide a decision tree for reStructuredText markup in docs <10729>`

No one seems to care
^^^^^^^^^^^^^^^^^^^^

* :issue:`Read the docs search box is very laggy <10730>`