docs: better structure

Author: koczkatamas

docs/introduction.md

@@ -79,14 +79,3 @@ These areas are moon-shot plans to explore in the future in case kernelXDK deeme
 * Syzkaller-integration: generate exploits automatically from crashes.
 
 * Windows, macOS support.
-
-# Components
-
-```{toctree}
-:maxdepth: 1
-
-libxdk
-kxdb_database
-kernel_image_tools
-gadget_tools
-```

docs/src/about/index.md renamed to docs/src/about/introduction.md

@@ -23,32 +23,23 @@ Key Features and Benefits
 * **Designed for Broad Support**: ``kernelXDK`` is engineered with the capability to support a wide range of kernel exploitation scenarios and environments.
 
 
-About
-===============
-
 .. toctree::
    :maxdepth: 2
    :caption: About
 
-   about/index
-
-Installation
-============
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Setup
-
-   installation/index
+   about/introduction
+   about/kxdb_database
 
 .. toctree::
    :maxdepth: 2
    :caption: libxdk
 
+   libxdk/README
+   libxdk/how_to_get_started
    libxdk/api
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Commandline Tools
 
    commandline_tools/index
@@ -58,10 +49,3 @@ Installation
    or have suggestions, please open an issue on our `GitHub repository`_.
 
 .. _GitHub repository: https://github.com/google/kernel-research
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/src/index.rst

@@ -1,5 +1,5 @@
 API Reference
-======================
+=============
 
 .. toctree::
    :maxdepth: 2

docs/src/about/libxdk.md renamed to docs/src/libxdk/README.md

@@ -1,18 +1,20 @@
-A work-in-progress Linux Kernel exploitation kit, which will contain the necessary building blocks for building exploits for the Linux kernel which can target various kernel versions:
+# What is libxdk?
 
+A work-in-progress Linux Kernel eXploitation Development Kit library, which will contain the necessary building blocks for building exploits for the Linux kernel which can target various kernel versions:
+
+  * `[DONE]` RIP control (including stack pivots, ROP actions)
   * `[TODO]` vulnerability triggers
   * `[TODO]` kASLR leaks
   * `[TODO]` utility functions commonly used in kernel exploitations
   * `[TODO]` primitive transfers (e.g. UAF -> Arbitrary Write)
   * `[TODO]` spraying techniques (including cross-cache)
-  * `[WIP]` RIP control (including stack pivots, ROP actions)
   * `[TODO]` "Exploit recipes": declarative structure how to put together the above "ingredients" to create an exploit (can be adjusted to different targets)
 
-# Prerequisites
+# Usage
 
-  * `sudo apt install libkeyutils-dev`
+## Prerequisites
 
-# Usage
+  * `sudo apt install libkeyutils-dev`
 
 Currently the exploit kit can be used by including its' source code into the exploits. Its API is not stable yet and cannot be used as a library.