From: Jonathan Corbet <corbet@lwn.net>
To: ksummit@lists.linux.dev
Subject: [TECH TOPIC] Kernel documentation
Date: Fri, 16 Jun 2023 11:48:56 -0600 [thread overview]
Message-ID: <87fs6rxppz.fsf@meer.lwn.net> (raw)
The documentation discussion at past kernel summits has been lively, so
I think we should do it again. Some topics I would bring to a session
this year would include:
- The ongoing restructuring of the Documentation/ directory. I've been
slowly moving the architecture docs into Documentation/arch/, but
would like to do more to reduce the clutter of the top-level directory
and make our documentation tree more closely resemble the organization
of the source.
- Structure. We continue to collect documents, but do little to tie
them together into a coherent whole. Do we want to change that and,
if so, how?
- Support for documentation work. There is nobody in the community who
is paid to put any significant time into documentation, and it shows.
How can we fix that?
- Infrastructure. Sphinx brings a lot but is far from perfect; what can
we do to improve it?
Other topics will certainly arise as well.
jon
next reply other threads:[~2023-06-16 17:54 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-16 17:48 Jonathan Corbet [this message]
2023-06-20 16:02 ` [TECH TOPIC] Kernel documentation Jani Nikula
2023-06-20 19:30 ` Jonathan Corbet
2023-11-20 12:06 ` Vegard Nossum
2023-11-20 13:50 ` Jonathan Corbet
2023-11-20 14:42 ` Mauro Carvalho Chehab
2023-11-20 14:49 ` Johannes Berg
2023-11-20 20:54 ` Jonathan Corbet
2023-06-29 21:34 ` Intersphinx ([TECH TOPIC] Kernel documentation) Jonathan Corbet
2023-06-30 13:17 ` Jani Nikula
2023-06-30 16:54 ` Theodore Ts'o
2023-06-30 17:11 ` Jonathan Corbet
2023-07-02 1:46 ` Steven Rostedt
2023-07-02 4:56 ` Linus Torvalds
2023-07-02 13:18 ` James Bottomley
2023-07-02 18:32 ` Steven Rostedt
2023-07-02 18:44 ` Linus Torvalds
2023-07-03 2:46 ` Theodore Ts'o
2023-06-21 11:04 ` [TECH TOPIC] Kernel documentation Thorsten Leemhuis
2023-06-26 14:34 ` Jan Kara
2023-11-11 12:42 ` Vegard Nossum
2023-11-11 15:14 ` Jonathan Corbet
2023-11-20 12:20 ` Vegard Nossum
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87fs6rxppz.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=ksummit@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).