Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Costa Shulyupin <costa.shul@redhat.com>,
        "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
        open list <linux-kernel@vger.kernel.org>
Cc:     Costa Shulyupin <costa.shul@redhat.com>
Subject: Re: [PATCH] docs: remove tree links from the main index
In-Reply-To: <20230718185156.1015753-1-costa.shul@redhat.com>
References: <20230718185156.1015753-1-costa.shul@redhat.com>
Date:   Fri, 21 Jul 2023 13:55:57 -0600
Message-ID: <87y1j9ca42.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

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

> and leave only their neighbor subsystem-apis
>
> because these links are already listed under
> section "Core subsystems" of Documentation/subsystem-apis.rst:
>
>     Core subsystems
>     ---------------
>
>     .. toctree::
>        :maxdepth: 1
>
>        core-api/index
>        driver-api/index
>        mm/index
>        power/index
>        scheduler/index
>        timers/index
>        locking/index
>
> Reference:
> - https://www.kernel.org/doc/html/next/subsystem-apis.html#core-subsystems
>
> Motivation:
> - make the documentation more organized
> - increase consistency, observability and maintainability
> - improve balance of ToC tree by reducing overly populated lists
> - avoid duplicate parallel links
> - escape tangling of links
> - intention to fit the main index into one page
>
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
> ---
>  Documentation/index.rst | 3 ---
>  1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 9dfdc826618c..8d8b7eab1131 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -38,10 +38,7 @@ kernel.
>  .. toctree::
>     :maxdepth: 1
>  
> -   core-api/index
> -   driver-api/index
>     subsystem-apis
> -   Locking in the kernel <locking/index>

So I don't really see the value of this.  It takes away some of the most
important links from the documentation front page, leaving the "Internal
API manuals" section nearly empty.  Why would we want to do this?

Thanks,

jon