Re-arrange documentation

doc/source/behavior-trees/create-tree.rst

@@ -0,0 +1,10 @@
+.. _create_tree::
+
+Creating your own Behavior Trees
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Make a scene file for your agent, or open an existing scene.
+2. Add a :ref:`BTPlayer<class_BTPlayer>` node to your scene.
+3. Select :ref:`BTPlayer<class_BTPlayer>`, and create a new behavior tree in the inspector.
+4. Optionally, you can save the behavior tree to a file using the property's context menu.
+5. Click the behavior tree property to open it in the LimboAI editor.

doc/source/behavior-trees/custom-tasks.rst

@@ -1,7 +1,7 @@
 .. _custom_tasks:
 
-Creating custom tasks in GDScript
+Creating custom tasks
-=================================
+=====================
 
 By default, user tasks should be placed in the ``res://ai/tasks``
 directory. You can set an alternative location for user tasks in the
@@ -145,3 +145,47 @@ Example 2: InRange condition
            return SUCCESS
        else:
            return FAILURE
+
+.. _creating_tasks_in_c
+
+Creating tasks in C#
+--------------------
+
+You can use the following script template for custom tasks:
+
+.. code:: csharp
+
+    using Godot;
+    using System;
+
+    [Tool]
+    public partial class _CLASS_ : _BASE_
+    {
+        public override string _GenerateName()
+        {
+            return "_CLASS_";
+        }
+
+        public override void _Setup()
+        {
+        }
+
+        public override void _Enter()
+        {
+        }
+
+        public override void _Exit()
+        {
+        }
+
+        public override Status _Tick(double delta)
+        {
+            return Status.Success;
+        }
+
+        public override string[] _GetConfigurationWarnings()
+        {
+            return Array.Empty<string>();
+        }
+    }
+

doc/source/behavior-trees/debugging.rst

@@ -0,0 +1,8 @@
+.. _debugging:
+
+Debugging Behavior Trees
+========================
+
+In Godot Engine, follow to "Bottom Panel > Debugger > LimboAI" tab. With the LimboAI debugger,
+you can inspect any currently active behavior tree within the running project. The debugger can be detached
+from the main editor window, which can be particularly useful if you have a HiDPI or a secondary display.

doc/source/getting-started/c-sharp.rst

@@ -21,47 +21,3 @@ Each provided build comes with a GodotSharp folder, which has packages under
 Regarding GDExtension, I can only confirm success with the module version and C#.
 Unfortunately, I haven't had any luck with the GDExtension version yet.
 If you've had success with GDExtension, please let me know via Discord or email.
-
-Creating custom tasks in C#
----------------------------
-
-   **🛈 Note:** For more information, check out :ref:`creating custom tasks in GDScript <custom_tasks>`.
-
-You can use the following script template for custom tasks:
-
-.. code:: csharp
-
-    using Godot;
-    using System;
-
-    [Tool]
-    public partial class _CLASS_ : _BASE_
-    {
-        public override string _GenerateName()
-        {
-            return "_CLASS_";
-        }
-
-        public override void _Setup()
-        {
-        }
-
-        public override void _Enter()
-        {
-        }
-
-        public override void _Exit()
-        {
-        }
-
-        public override Status _Tick(double delta)
-        {
-            return Status.Success;
-        }
-
-        public override string[] _GetConfigurationWarnings()
-        {
-            return Array.Empty<string>();
-        }
-    }
-

doc/source/getting-started/getting-limboai.rst

@@ -0,0 +1,48 @@
+Getting LimboAI
+===============
+
+LimboAI can be used as either a C++ module or as a GDExtension shared library.
+There are some differences between the two. In short, GDExtension version is more
+convenient to use but somewhat limited in features. The module version is the most feature-full and slightly more performant, but it requires using custom engine builds including the export templates.
+Whichever you choose to use, your project will stay compatible with both and you can switch from one to
+the other any time.
+
+Choose the version you'd like to use. The module version provides better editor
+experience and performance, while the GDExtension version is more convenient to use.
+If you're unsure, start with the GDExtension version.
+You can change your decision at any time - both versions are fully compatible.
+
+Get GDExtension version
+------------------------
+
+GDExtension is the most convenient way of using the LimboAI plugin, but it comes
+with certain limitations:
+
+* Built-in documentation is not available. The plugin will open online documentation instead when requested.
+* Documentation tooltips are not available.
+* Handy :ref:`class_BBParam` property editor is not available in the extension due to dependencies on the engine classes that are not available in the Godot API.
+
+    **🛈 See also:** `What is GDExtension? <https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/what_is_gdextension.html#what-is-gdextension>`_
+
+Installation instructions:
+
+1. Make sure you're using the latest stable version of the Godot editor.
+2. Create a new project for your experiments with LimboAI.
+3. In Godot, click AssetLib tab at the top of the screen and search for LimboAI. Download it. LimboAI plugin will be downloaded with the demo project files. Don't mind the errors printed at this point, this is due to the extension library not being loaded just yet.
+4. Reload your project with `Project -> Reload project`. There shouldn't be any errors printed now.
+5. In the project files, locate a scene file called `showcase.tscn` and run it. It's the demo's entry point.
+
+Get module version
+-------------------
+
+Precompiled builds are available on the official
+`LimboAI GitHub <https://github.com/limbonaut/limboai#getting-limboai>`_ page,
+and in the Asset Library (coming soon!).
+
+Installation instructions:
+
+1. In `GitHub releases <https://github.com/limbonaut/limboai/releases/>`_, download the latest pre-compiled release build for your platform.
+2. Download the demo project archive from the same release.
+3. Extract the pre-compiled editor and the demo project files.
+4. Launch the pre-compiled editor binary, import and open the demo project.
+5. Run the project.

doc/source/hierarchical-state-machines/create-hsm.rst

@@ -1,8 +1,8 @@
 .. _hsm:
 
 
-State Machines
+Create State Machines
-==============
+=====================
 
 This guide will show how to set up and use a state machine using :ref:`LimboHSM<class_LimboHSM>`.
 

doc/source/index.rst

@@ -18,73 +18,36 @@ of agents in a game (e.g., characters, enemies, entities). They are designed to
 make it easier to create complex and highly modular behaviors for your games.
 To learn more about behavior trees, check out :ref:`introduction`.
 
-
+**Hierarchical State Machines** are finite state machines that allow any state to host their own
-Getting LimboAI
+sub-state machine. This allows you to tackle your AI's state and transition complexity by breaking down
----------------
+one big state machine into multiple smaller ones.
-
-Precompiled builds are available on the official
-`LimboAI GitHub <https://github.com/limbonaut/limboai#getting-limboai>`_ page,
-and in the Asset Library (coming soon!).
-
-LimboAI can be used as either a C++ module or as a GDExtension shared library.
-There are some differences between the two. In short, GDExtension version is more
-convenient to use but somewhat limited in features. Whichever you choose to use,
-your project will stay compatible with both and you can switch from one to
-the other any time. For more information on this topic, see :ref:`gdextension`.
-
-   **🛈 Note:** Class reference is available in the side bar.
-
-
-First steps
------------
-
-Choose the version you'd like to use. The module version provides better editor
-experience and performance, while the GDExtension version is more convenient to use.
-If you're unsure, start with the GDExtension version.
-You can change your decision at any time - both versions are fully compatible.
-For more information, see :ref:`gdextension`.
-
-With GDExtension version
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-1. Make sure you're using the latest stable version of the Godot editor.
-2. Create a new project for your experiments with LimboAI.
-3. In Godot, click AssetLib tab at the top of the screen and search for LimboAI. Download it. LimboAI plugin will be downloaded with the demo project files. Don't mind the errors printed at this point, this is due to the extension library not being loaded just yet.
-4. Reload your project with `Project -> Reload project`. There shouldn't be any errors printed now.
-5. In the project files, locate a scene file called `showcase.tscn` and run it. It's the demo's entry point.
-
-With module version
-~~~~~~~~~~~~~~~~~~~
-
-1. In `GitHub releases <https://github.com/limbonaut/limboai/releases/>`_, download the latest pre-compiled release build for your platform.
-2. Download the demo project archive from the same release.
-3. Extract the pre-compiled editor and the demo project files.
-4. Launch the pre-compiled editor binary, import and open the demo project.
-5. Run the project.
-
-Creating your own behavior trees
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-1. Make a scene file for your agent, or open an existing scene.
-2. Add a :ref:`BTPlayer<class_BTPlayer>` node to your scene.
-3. Select :ref:`BTPlayer<class_BTPlayer>`, and create a new behavior tree in the inspector.
-4. Optionally, you can save the behavior tree to a file using the property's context menu.
-5. Click the behavior tree property to open it in the LimboAI editor.
-
 
 .. toctree::
    :hidden:
    :maxdepth: 1
    :caption: Getting started
 
-   getting-started/introduction
+   getting-started/getting-limboai
-   getting-started/custom-tasks
-   getting-started/using-blackboard
-   getting-started/accessing-nodes
-   getting-started/hsm
-   getting-started/gdextension
    getting-started/c-sharp
-   getting-started/featured-classes
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Behavior Trees
+
+   behavior-trees/introduction
+   behavior-trees/create-tree
+   behavior-trees/custom-tasks
+   behavior-trees/using-blackboard
+   behavior-trees/accessing-nodes
+   behavior-trees/debugging
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Hierarchical State MachineS
+
+   hierarchical-state-machines/create-hsm
 
 .. toctree::
    :hidden:
@@ -92,11 +55,5 @@ Creating your own behavior trees
    :caption: Class reference
    :glob:
 
+   classes/featured-classes
    classes/class_*
-
-Debugging behavior trees
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-In Godot Engine, follow to "Bottom Panel > Debugger > LimboAI" tab. With the LimboAI debugger,
-you can inspect any currently active behavior tree within the running project. The debugger can be detached
-from the main editor window, which can be particularly useful if you have a HiDPI or a secondary display.