Skip to content

Commit 3e3880e

Browse files
committed
[lldb] Simplify the LLDB website structure
Feedback I hear regularly is that the LLDB website is hard to navigate. This patch is an attempt to simplify things by breaking the website up in 3 major areas: "Using LLDB", "Scripting LLDB" and "Developing LLDB". - The majority of the "project" pages were eliminated. The projects page was moved under "Developing LLDB". The releases page was replaced with a link under "External links". The other pages (goals, features and status) were pretty outdated and while they probably made sense in the past, they don't feel all that relevant anymore now that LLDB is an established debugger. - "USE & EXTENSION" was renamed to "Using LLDB". Besides that, this section remained mostly unchanged. The exception are the Python pages which were moved under "Scripting LLDB". - "Development" was renamed to "Developing LLDB" and now houses all the resources for LLDB developers. The old "Design" section (which only contained two pages) was moved back under here too. Differential revision: https://reviews.llvm.org/D158023
1 parent 29b2009 commit 3e3880e

File tree

11 files changed

+25
-183
lines changed

11 files changed

+25
-183
lines changed

lldb/docs/.htaccess

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Redirect 301 /varformats.html https://lldb.llvm.org/use/variable.html
1515
Redirect 301 /resources/source.html https://lldb.llvm.org/resources/contributing.html
1616
Redirect 301 /resources/download.html https://lldb.llvm.org/status/releases.html
1717
Redirect 301 /use/architecture.html https://lldb.llvm.org/resources/architecture.html
18-
Redirect 301 /resources/architecture.html https://lldb.llvm.org/design/overview.html
19-
Redirect 301 /resources/reproducers.html https://lldb.llvm.org/design/reproducers.html
20-
Redirect 301 /resources/sbapi.html https://lldb.llvm.org/design/sbapi.html
18+
Redirect 301 /resources/architecture.html https://lldb.llvm.org/resources/overview.html
19+
Redirect 301 /design/sbapi.html https://lldb.llvm.org/resources/sbapi.html
20+
Redirect 301 /design/overview.html https://lldb.llvm.org/resources/overview.html
21+
Redirect 301 /use/extensions.html https://lldb.llvm.org/resources/extensions.html
2122

2223
# Redirect old Python API to new Python API.
2324
Redirect 301 /python_reference/lldb-module.html https://lldb.llvm.org/python_api.html

lldb/docs/index.rst

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -107,77 +107,62 @@ messages are automatically sent to the `lldb-commits
107107
<http://lists.llvm.org/mailman/listinfo/lldb-commits>`__ mailing list, and
108108
this is also the preferred mailing list for patch submissions.
109109

110-
See the :doc:`Projects page <status/projects>` if you are looking for some
110+
See the :doc:`Projects page <resources/projects>` if you are looking for some
111111
interesting areas to contribute to lldb.
112112

113113
.. toctree::
114114
:hidden:
115115
:maxdepth: 1
116-
:caption: Project
117-
118-
status/goals
119-
status/features
120-
status/status
121-
status/projects
122-
status/releases
123-
124-
.. toctree::
125-
:hidden:
126-
:maxdepth: 1
127-
:caption: Use & Extension
116+
:caption: Using LLDB
128117

129118
use/tutorial
130119
use/map
131120
use/formatting
132121
use/variable
133122
use/symbolication
134123
use/symbols
135-
use/extensions
136-
use/python
137-
use/python-reference
138124
use/remote
139125
use/qemu-testing
140126
use/intel_pt
141127
use/ondemand
142128
use/troubleshooting
143129
use/links
130+
Man Page <man/lldb>
144131

145132
.. toctree::
146133
:hidden:
147134
:maxdepth: 1
148-
:caption: Development
149-
150-
resources/contributing
151-
resources/build
152-
resources/test
153-
resources/fuzzing
154-
resources/bots
155-
resources/caveats
156-
135+
:caption: Scripting LLDB
157136

158-
.. toctree::
159-
:hidden:
160-
:maxdepth: 1
161-
:caption: Design
137+
use/python
138+
use/python-reference
139+
Python API <python_api>
162140

163-
design/overview
164-
design/sbapi
165141

166142
.. toctree::
167143
:hidden:
168144
:maxdepth: 1
169-
:caption: Reference
145+
:caption: Developing LLDB
170146

171-
Public Python API <python_api>
147+
resources/overview
148+
resources/contributing
149+
resources/build
150+
resources/test
151+
resources/fuzzing
152+
resources/bots
153+
resources/sbapi
154+
resources/extensions
155+
resources/caveats
156+
resources/projects
172157
Public C++ API <https://lldb.llvm.org/cpp_reference/namespacelldb.html>
173158
Private C++ API <https://lldb.llvm.org/cpp_reference/index.html>
174-
Man Page <man/lldb>
175159

176160
.. toctree::
177161
:hidden:
178162
:maxdepth: 1
179163
:caption: External Links
180164

181165
Source Code <https://github.com/llvm/llvm-project>
166+
Releases <https://github.com/llvm/llvm-project/releases>
182167
Code Reviews <https://reviews.llvm.org>
183168
Bug Reports <https://github.com/llvm/llvm-project/issues/labels/lldb/>
File renamed without changes.

lldb/docs/resources/fuzzing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Fuzzing LLDB
2-
============
1+
Fuzzing
2+
=======
33

44
Overview
55
--------
File renamed without changes.
File renamed without changes.
File renamed without changes.

lldb/docs/status/features.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

lldb/docs/status/goals.rst

Lines changed: 0 additions & 44 deletions
This file was deleted.

lldb/docs/status/releases.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

lldb/docs/status/status.rst

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)