Skip to content

Commit 9ee3678

Browse files
Zildj1anJonathan Corbet
authored andcommitted
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: Carlos Bilbao <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 23764f1 commit 9ee3678

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

Documentation/index.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ community and getting your work upstream.
2222
.. toctree::
2323
:maxdepth: 1
2424

25-
process/development-process
26-
process/submitting-patches
25+
Development process <process/development-process>
26+
Submitting patches <process/submitting-patches>
2727
Code of conduct <process/code-of-conduct>
28-
maintainer/index
28+
Maintainer handbook <maintainer/index>
2929
All development-process docs <process/index>
3030

3131

@@ -38,10 +38,10 @@ kernel.
3838
.. toctree::
3939
:maxdepth: 1
4040

41-
core-api/index
42-
driver-api/index
43-
subsystem-apis
44-
Locking in the kernel <locking/index>
41+
Core API <core-api/index>
42+
Driver APIs <driver-api/index>
43+
Subsystems <subsystem-apis>
44+
Locking <locking/index>
4545

4646
Development tools and processes
4747
===============================
@@ -51,15 +51,15 @@ Various other manuals with useful information for all kernel developers.
5151
.. toctree::
5252
:maxdepth: 1
5353

54-
process/license-rules
55-
doc-guide/index
56-
dev-tools/index
57-
dev-tools/testing-overview
58-
kernel-hacking/index
59-
trace/index
60-
fault-injection/index
61-
livepatch/index
62-
rust/index
54+
Licensing rules <process/license-rules>
55+
Writing documentation <doc-guide/index>
56+
Development tools <dev-tools/index>
57+
Testing guide <dev-tools/testing-overview>
58+
Hacking guide <kernel-hacking/index>
59+
Tracing <trace/index>
60+
Fault injection <fault-injection/index>
61+
Livepatching <livepatch/index>
62+
Rust <rust/index>
6363

6464

6565
User-oriented documentation
@@ -72,11 +72,11 @@ developers seeking information on the kernel's user-space APIs.
7272
.. toctree::
7373
:maxdepth: 1
7474

75-
admin-guide/index
76-
The kernel build system <kbuild/index>
77-
admin-guide/reporting-issues.rst
78-
User-space tools <tools/index>
79-
userspace-api/index
75+
Administration <admin-guide/index>
76+
Build system <kbuild/index>
77+
Reporting issues <admin-guide/reporting-issues.rst>
78+
Userspace tools <tools/index>
79+
Userspace API <userspace-api/index>
8080

8181
See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
8282
which are kept separately from the kernel's own documentation.
@@ -89,8 +89,8 @@ platform firmwares.
8989
.. toctree::
9090
:maxdepth: 1
9191

92-
firmware-guide/index
93-
devicetree/index
92+
Firmware <firmware-guide/index>
93+
Firmware and Devicetree <devicetree/index>
9494

9595

9696
Architecture-specific documentation
@@ -99,7 +99,7 @@ Architecture-specific documentation
9999
.. toctree::
100100
:maxdepth: 2
101101

102-
arch/index
102+
CPU architectures <arch/index>
103103

104104

105105
Other documentation
@@ -112,7 +112,7 @@ to ReStructured Text format, or are simply too old.
112112
.. toctree::
113113
:maxdepth: 1
114114

115-
staging/index
115+
Unsorted documentation <staging/index>
116116
RAS/ras
117117

118118

@@ -122,7 +122,7 @@ Translations
122122
.. toctree::
123123
:maxdepth: 2
124124

125-
translations/index
125+
Translations <translations/index>
126126

127127
Indices and tables
128128
==================

0 commit comments

Comments
 (0)