public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Costa Shulyupin <costa.shul@redhat.com>
Cc: "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	open list <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] docs: remove tree links from the main index
Date: Mon, 24 Jul 2023 10:19:56 -0600	[thread overview]
Message-ID: <87mszlb7tf.fsf@meer.lwn.net> (raw)
In-Reply-To: <CADDUTFxu4owj_aXo2OBug3qBLbmS8boNXzcra8qLsqDYwN5Kpg@mail.gmail.com>

Costa Shulyupin <costa.shul@redhat.com> writes:

> The left column "Contents" is overloaded and hard to use. The value of
> this patch is to make it more usable.
>
> Sections of the main page are not displayed after patch "docs: Add
> more information to the HTML sidebar". So sections don't work now and
> should be fixed too.
>
> I have in mind to reorganize the main page so the left column
> "Contents" becomes usable.

No, that is not the right approach.

Much of our documentation is just thrown together in haphazard ways, but
the front page has actually been the target of a certain amount of
thought.  It is, after all, the entry point into our documentation.

This page can surely be improved.  But thrashing it up for the purpose
of making the sidebar better is getting the priorities wrong; the front
page is far more important.  The way to improve the sidebar is to change
how that is generated; that almost certainly requires digging into the
theme code.  That has been on my list for some time, but I haven't
gotten to it.  It would be wonderful if somebody beat me to it.

Thanks,

jon

      reply	other threads:[~2023-07-24 16:20 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-18 18:51 [PATCH] docs: remove tree links from the main index Costa Shulyupin
2023-07-21 19:55 ` Jonathan Corbet
2023-07-22  2:21   ` Costa Shulyupin
2023-07-24 16:19     ` Jonathan Corbet [this message]

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=87mszlb7tf.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=costa.shul@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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