mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Carlos Bilbao <carlos.bilbao@amd.com>
To: <corbet@lwn.net>, <rdunlap@infradead.org>, <vegard.nossum@oracle.com>
Cc: <bilbao@vt.edu>, <linux-doc@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>,
	Carlos Bilbao <carlos.bilbao@amd.com>
Subject: [PATCH v2 0/2] docs: Include simplified link titles in main index
Date: Tue, 9 Jan 2024 09:56:41 -0600	[thread overview]
Message-ID: <20240109155643.3489369-1-carlos.bilbao@amd.com> (raw)

The general consensus is that the documentation's website main entry point
and its sidebar leave room for improvement. Something we can easily fix is
that there's too much duplicated text.

To that point, consider the titles "The Linux kernel user's and
administrator's guide" and "The Linux kernel user-space API guide." We get
it, it's the Linux kernel. It's assumed that everything listed pertains to
the Linux kernel, given the overarching title, "The Linux Kernel
documentation." Constant repetition of "Linux" and "kernel" (45 times
each), "documentation" (21 times), and "guide" (18 times) are excessive and
affect UX.

I propose simplifying without altering actual document titles, the text
linking to these documents on the main page ("link titles"). For example,
"The Linux kernel user's and administrator's guide" could become "User's
and Administrator's Guide," and "A guide to the Kernel Development Process"
could be "Development Process". This is what my patch does.

Also, I send a patch fixing the formatting of the title of
admin-guide/index.rst (The Linux kernel user's and administrator's guide);
a detail I noticed because the link title would not work otherwise.

Thanks,
Carlos

Carlos Bilbao (2):
    docs: Correct formatting of title in admin-guide/index.rst
    docs: Include simplified link titles in main index

---

v1 Link: https://lore.kernel.org/lkml/58e78693-82d1-451d-a546-51fb64ef6eb5@vt.edu/T/

Changes since v1:

- Apply feedback:
  Driver implementation API -> Driver APIs
  Testing -> Testing guide
  Hacking -> Hacking guides
  User-space tools -> Userspace tools
  User-space API -> Userspace APIs
  CPU Architectures -> CPU architectures

- Include patch fixing the title of The Linux kernel user's and
  administrator's guide.

- Minor changes: Change "main page's index" for "main index" in commit
  subject. Also use my work email to sign the commits.

---
Documentation/admin-guide/index.rst |  1 +
Documentation/index.rst             | 52 ++++++++++++++---------------
2 files changed, 27 insertions(+), 26 deletions(-)


             reply	other threads:[~2024-01-09 15:56 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-09 15:56 Carlos Bilbao [this message]
2024-01-09 15:56 ` [PATCH v2 1/2] docs: Correct formatting of title in admin-guide/index.rst Carlos Bilbao
2024-01-09 15:56 ` [PATCH v2 2/2] docs: Include simplified link titles in main index Carlos Bilbao
2024-02-21 19:58 ` [PATCH v2 0/2] " Carlos Bilbao
2024-02-21 20:40   ` Jonathan Corbet
2024-02-22 14:34     ` Carlos Bilbao

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=20240109155643.3489369-1-carlos.bilbao@amd.com \
    --to=carlos.bilbao@amd.com \
    --cc=bilbao@vt.edu \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=vegard.nossum@oracle.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

all inboxes | Powered by JetHome®