Commit 9ee36780 authored by Carlos Bilbao's avatar Carlos Bilbao Committed by Jonathan Corbet

docs: Include simplified link titles in main index

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: default avatarCarlos Bilbao <carlos.bilbao@amd.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240109155643.3489369-3-carlos.bilbao@amd.com
parent 23764f18
...@@ -22,10 +22,10 @@ community and getting your work upstream. ...@@ -22,10 +22,10 @@ community and getting your work upstream.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
process/development-process Development process <process/development-process>
process/submitting-patches Submitting patches <process/submitting-patches>
Code of conduct <process/code-of-conduct> Code of conduct <process/code-of-conduct>
maintainer/index Maintainer handbook <maintainer/index>
All development-process docs <process/index> All development-process docs <process/index>
...@@ -38,10 +38,10 @@ kernel. ...@@ -38,10 +38,10 @@ kernel.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
core-api/index Core API <core-api/index>
driver-api/index Driver APIs <driver-api/index>
subsystem-apis Subsystems <subsystem-apis>
Locking in the kernel <locking/index> Locking <locking/index>
Development tools and processes Development tools and processes
=============================== ===============================
...@@ -51,15 +51,15 @@ Various other manuals with useful information for all kernel developers. ...@@ -51,15 +51,15 @@ Various other manuals with useful information for all kernel developers.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
process/license-rules Licensing rules <process/license-rules>
doc-guide/index Writing documentation <doc-guide/index>
dev-tools/index Development tools <dev-tools/index>
dev-tools/testing-overview Testing guide <dev-tools/testing-overview>
kernel-hacking/index Hacking guide <kernel-hacking/index>
trace/index Tracing <trace/index>
fault-injection/index Fault injection <fault-injection/index>
livepatch/index Livepatching <livepatch/index>
rust/index Rust <rust/index>
User-oriented documentation User-oriented documentation
...@@ -72,11 +72,11 @@ developers seeking information on the kernel's user-space APIs. ...@@ -72,11 +72,11 @@ developers seeking information on the kernel's user-space APIs.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
admin-guide/index Administration <admin-guide/index>
The kernel build system <kbuild/index> Build system <kbuild/index>
admin-guide/reporting-issues.rst Reporting issues <admin-guide/reporting-issues.rst>
User-space tools <tools/index> Userspace tools <tools/index>
userspace-api/index Userspace API <userspace-api/index>
See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_, See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
which are kept separately from the kernel's own documentation. which are kept separately from the kernel's own documentation.
...@@ -89,8 +89,8 @@ platform firmwares. ...@@ -89,8 +89,8 @@ platform firmwares.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
firmware-guide/index Firmware <firmware-guide/index>
devicetree/index Firmware and Devicetree <devicetree/index>
Architecture-specific documentation Architecture-specific documentation
...@@ -99,7 +99,7 @@ Architecture-specific documentation ...@@ -99,7 +99,7 @@ Architecture-specific documentation
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
arch/index CPU architectures <arch/index>
Other documentation Other documentation
...@@ -112,7 +112,7 @@ to ReStructured Text format, or are simply too old. ...@@ -112,7 +112,7 @@ to ReStructured Text format, or are simply too old.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
staging/index Unsorted documentation <staging/index>
RAS/ras RAS/ras
...@@ -122,7 +122,7 @@ Translations ...@@ -122,7 +122,7 @@ Translations
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
translations/index Translations <translations/index>
Indices and tables Indices and tables
================== ==================
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment