From mboxrd@z Thu Jan  1 00:00:00 1970
From: Jonathan Corbet <corbet@lwn.net>
Date: Fri, 17 Jun 2022 14:57:10 -0600
Subject: [Ksummit-discuss] [TECH TOPIC] What kernel documentation could be
Message-ID: <87sfo3nh3t.fsf@meer.lwn.net>
Message-ID: <20220617205710.QALI-P3fei6--HyNgkD8H_Vy4lhy8DoJZ0NewhhNAEQ@z>

The development community has put a lot of work into the kernel's
documentation directory in recent years, with visible results. But the
kernel's documentation still falls far short of the standard set by many
other projects, and there is a great deal of "tribal knowledge" in our
community that is not set down. I'd like to look at the successes and
failures of the work so far, but intent to focus on a discussion of what
our documentation should be and what we can do to get it there.

Questions to discuss include:

 - Bringing an coherent overall structure to Documentation/

 - Making it easier for developers to improve the documentation.

 - What we would like from Sphinx and what we can do to make it happen

 - Making the docs build system less ugly and more maintainable

 - Integrating rustdoc documentation

jon