From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3A930C10F04 for ; Mon, 11 Dec 2023 01:42:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232297AbjLKBmD (ORCPT ); Sun, 10 Dec 2023 20:42:03 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43274 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229483AbjLKBmC (ORCPT ); Sun, 10 Dec 2023 20:42:02 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DD3D9D7; Sun, 10 Dec 2023 17:42:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=DodnFSVXUrv+dYqEJmTFxfTJUgoqYPQKyRrSoXKQiis=; b=KovonbwySyDVaBHuxdMEzRfnQY Y6cB+On3e3V/hG6OnJ0GvxbiyG5DOEqSx9j5nTJa101UXBu2MPPI+oz3A9/E4PYRD37lp4eoiqaQi v3dOeiDQ6Hn63pElBUjJSq2T4wH3H3WQUQgZ1VfmQp2HLElZWPSd2kma9a/SllVvHA+qtf2/GUBsH SQvVLQjqP4F4m4qzr8zzoHNhcrBhZUnRKoEvsotbzYex9e5gY4e3pUCl+wojO2r+Xn4Ib4M/6nTFn zVNaBCR+Db0emQJ10y+XOHrpt/TedJsSn7vWBoo2lTPyu9mYm3Yyvi40PgJHLXVzHSWkFlLkALIC4 FHoBxlZg==; Received: from [50.53.46.231] (helo=[192.168.254.15]) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rCVIs-003jq4-1a; Mon, 11 Dec 2023 01:41:50 +0000 Message-ID: <9b52c145-7466-4e81-a911-25f472c2a2ea@infradead.org> Date: Sun, 10 Dec 2023 17:41:49 -0800 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH 1/1 RESEND] docs: Include simplified link titles in main page's index Content-Language: en-US To: Carlos Bilbao , Jonathan Corbet Cc: Miguel Ojeda , alex.gaynor@gmail.com, wedsonaf@gmail.com, boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com, benno.lossin@proton.me, a.hindborg@samsung.com, aliceryhl@google.com, "linux-doc@vger.kernel.org" , Linux Kernel Mailing List References: <58e78693-82d1-451d-a546-51fb64ef6eb5@vt.edu> From: Randy Dunlap In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Carlos, On 12/10/23 17:20, Carlos Bilbao wrote: > Include simplified link titles in the main page's documentation index to > enhance website's readability and UX. Update the text that directs users to > various documents without changing the actual titles chosen by the authors. > > Signed-off-by: Carlos Bilbao > --- > Documentation/index.rst | 50 ++++++++++++++++++++--------------------- > 1 file changed, 25 insertions(+), 25 deletions(-) > > diff --git a/Documentation/index.rst b/Documentation/index.rst > index 9dfdc826618c..be395d0a4318 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -22,10 +22,10 @@ community and getting your work upstream. > .. toctree:: > :maxdepth: 1 > > - process/development-process > - process/submitting-patches > + Development process > + Submitting patches > Code of conduct > - maintainer/index > + Maintainer handbook > All development-process docs > > > @@ -38,10 +38,10 @@ kernel. > .. toctree:: > :maxdepth: 1 > > - core-api/index > - driver-api/index > - subsystem-apis > - Locking in the kernel > + Core API > + Driver implementation API > + Subsystems > + Locking > > Development tools and processes > =============================== > @@ -51,15 +51,15 @@ Various other manuals with useful information for all kernel developers. > .. toctree:: > :maxdepth: 1 > > - process/license-rules > - doc-guide/index > - dev-tools/index > - dev-tools/testing-overview > - kernel-hacking/index > - trace/index > - fault-injection/index > - livepatch/index > - rust/index > + Licensing rules > + Writing documentation > + Development tools > + Testing > + Hacking > + Tracing > + Fault injection > + Livepatching > + Rust > > > User-oriented documentation > @@ -72,11 +72,11 @@ developers seeking information on the kernel's user-space APIs. > .. toctree:: > :maxdepth: 1 > > - admin-guide/index > - The kernel build system Where do the subdir names "bailed" above and "bugled" below come from? > - admin-guide/reporting-issues.rst > + Administration > + Build system ^^^^^^ Thanks. > + Reporting issues > User-space tools > - userspace-api/index > + User-space API > > See also: the `Linux man pages `_, > which are kept separately from the kernel's own documentation. > @@ -89,8 +89,8 @@ platform firmwares. > .. toctree:: > :maxdepth: 1 > > - firmware-guide/index > - devicetree/index > + Firmware > + Firmware and Devicetree > > > Architecture-specific documentation > @@ -99,7 +99,7 @@ Architecture-specific documentation > .. toctree:: > :maxdepth: 2 > > - arch/index > + CPU Architectures > > > Other documentation > @@ -112,7 +112,7 @@ to ReStructured Text format, or are simply too old. > .. toctree:: > :maxdepth: 1 > > - staging/index > + Unsorted documentation > > > Translations > @@ -121,7 +121,7 @@ Translations > .. toctree:: > :maxdepth: 2 > > - translations/index > + Translations > > Indices and tables > ================== -- #Randy https://people.kernel.org/tglx/notes-about-netiquette https://subspace.kernel.org/etiquette.html