From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
Thorsten Leemhuis <linux@leemhuis.info>,
Kees Cook <keescook@chromium.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
Joe Perches <joe@perches.com>, David Vernet <void@manifault.com>,
Miguel Ojeda <ojeda@kernel.org>
Subject: Re: [PATCH v3 0/7] Rewrite the top-level index.rst
Date: Thu, 29 Sep 2022 09:34:18 -0600 [thread overview]
Message-ID: <87mtaii491.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220927160559.97154-1-corbet@lwn.net>
Jonathan Corbet <corbet@lwn.net> writes:
> The top-level index.rst file is the entry point for the kernel's
> documentation, especially for readers of the HTML output. It is currently
> a mess containing everything we thought to throw in there. Firefox says it
> would require 26 pages of paper to print it. That is not a user-friendly
> introduction.
>
> This series aims to improve our documentation entry point with a focus on
> rewriting index.rst. The result is, IMO, simpler and more approachable.
> For anybody who wants to see the rendered results without building the
> docs, have a look at:
>
> https://static.lwn.net/kerneldoc/
So I think I'll go ahead and drop this into docs-next shortly. Thanks
to everybody who has commented.
This, of course, has the potential to create conflicts with other 6.1
work that touches Documentation/index.rst. Amazingly, as far as I can
tell, there is only one linux-next commit touching that file - the
addition of the Rust docs. We'll want to be sure that doesn't get lost
during the merge window. I'll be sure to include a suitable heads-up in
my pull request.
Thanks,
jon
next prev parent reply other threads:[~2022-09-29 15:37 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-27 16:05 [PATCH v3 0/7] Rewrite the top-level index.rst Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 1/7] docs: promote the title of process/index.rst Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 2/7] docs: Rewrite the front page Jonathan Corbet
2022-09-28 3:32 ` Bagas Sanjaya
2022-09-27 16:05 ` [PATCH v3 3/7] docs: reconfigure the HTML left column Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 4/7] docs: remove some index.rst cruft Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 5/7] docs: move asm-annotations.rst into core-api Jonathan Corbet
2022-09-27 16:05 ` [PATCH v3 6/7] docs: put atomic*.txt and memory-barriers.txt into the core-api book Jonathan Corbet
2022-09-27 19:26 ` David Vernet
2022-09-27 16:05 ` [PATCH v3 7/7] docs: add a man-pages link to the front page Jonathan Corbet
2022-09-27 19:28 ` David Vernet
2022-09-28 6:21 ` Thorsten Leemhuis
2022-09-28 15:03 ` Randy Dunlap
2022-09-28 21:00 ` Jonathan Corbet
2022-09-27 16:21 ` [PATCH v3 0/7] Rewrite the top-level index.rst Joe Perches
2022-09-27 20:59 ` Randy Dunlap
2022-09-29 15:34 ` Jonathan Corbet [this message]
2022-09-29 15:59 ` Kees Cook
2022-09-29 17:31 ` Jonathan Corbet
2022-09-29 19:28 ` Jonathan Corbet
2022-09-29 17:47 ` Miguel Ojeda
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=87mtaii491.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=joe@perches.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=ojeda@kernel.org \
--cc=void@manifault.com \
/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 NNTP newsgroup(s).