JDevlieghere created this revision.
JDevlieghere added a reviewer: LLDB.
Herald added a subscriber: arphaman.
JDevlieghere requested review of this revision.
Create a "Design" section for the LLDB documentation. The goal would be to have
design documents that describe how the LLDB internals work. Currently they're
mixed together under the "Development" section which hurts discoverability and
makes it harder to understand where a new page should go. The existing pages
describing the reproducers, the structured data plugins, and the SB API could
be housed here but I'd love to see more pages being added here in the future.
Repository:
rLLDB LLDB
https://reviews.llvm.org/D88516
Files:
lldb/docs/.htaccess
lldb/docs/design/reproducers.rst
lldb/docs/design/sbapi.rst
lldb/docs/design/structureddataplugins.md
lldb/docs/index.rst
lldb/docs/resources/reproducers.rst
lldb/docs/resources/sbapi.rst
lldb/docs/resources/structureddataplugins.md
Index: lldb/docs/index.rst
===================================================================
--- lldb/docs/index.rst
+++ lldb/docs/index.rst
@@ -145,11 +145,18 @@
resources/build
resources/test
resources/bots
- resources/reproducers
- resources/structureddataplugins
- resources/sbapi
resources/caveats
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+ :caption: Design
+
+ design/reproducers
+ design/structureddataplugins
+ design/sbapi
+
.. toctree::
:hidden:
:maxdepth: 1
Index: lldb/docs/.htaccess
===================================================================
--- lldb/docs/.htaccess
+++ lldb/docs/.htaccess
@@ -9,6 +9,8 @@
Redirect 301 /source.html https://lldb.llvm.org/resources/contributing.html
Redirect 301 /tutorial.html https://lldb.llvm.org/use/tutorial.html
Redirect 301 /varformats.html https://lldb.llvm.org/use/variable.html
+Redirect 301 /resources/reproducers.html
https://lldb.llvm.org/design/reproducers.html
+Redirect 301 /resources/sbapi.html https://lldb.llvm.org/design/sbapi.html
# Sphinx redirects
Redirect 301 /resources/source.html
https://lldb.llvm.org/resources/contributing.html
Index: lldb/docs/index.rst
===================================================================
--- lldb/docs/index.rst
+++ lldb/docs/index.rst
@@ -145,11 +145,18 @@
resources/build
resources/test
resources/bots
- resources/reproducers
- resources/structureddataplugins
- resources/sbapi
resources/caveats
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+ :caption: Design
+
+ design/reproducers
+ design/structureddataplugins
+ design/sbapi
+
.. toctree::
:hidden:
:maxdepth: 1
Index: lldb/docs/.htaccess
===================================================================
--- lldb/docs/.htaccess
+++ lldb/docs/.htaccess
@@ -9,6 +9,8 @@
Redirect 301 /source.html https://lldb.llvm.org/resources/contributing.html
Redirect 301 /tutorial.html https://lldb.llvm.org/use/tutorial.html
Redirect 301 /varformats.html https://lldb.llvm.org/use/variable.html
+Redirect 301 /resources/reproducers.html https://lldb.llvm.org/design/reproducers.html
+Redirect 301 /resources/sbapi.html https://lldb.llvm.org/design/sbapi.html
# Sphinx redirects
Redirect 301 /resources/source.html https://lldb.llvm.org/resources/contributing.html
_______________________________________________
lldb-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
