linux-kernel - Re: [PATCH] docs: remove tree links from the main index

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Mon, 24 Jul 2023 10:19:56 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Costa Shulyupin <costa.shul@...hat.com>
Cc:     "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        open list <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] docs: remove tree links from the main index

Costa Shulyupin <costa.shul@...hat.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