Improve docs (#7005)

src/bonsai/docs/reference/costing_and_scheduling/index.rst

@@ -1,6 +1,9 @@
 Costing and Scheduling
 ======================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_costing-scheduling.png
    :alt: property editor costing and scheduling sub-tab
 

src/bonsai/docs/reference/drawings_and_documents/index.rst

@@ -1,6 +1,9 @@
 Drawings and documents
 ======================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_drawings-documents.png
    :alt: property editor drawings and documents sub-tab
 

src/bonsai/docs/reference/facility_management/index.rst

@@ -1,6 +1,9 @@
 Facility Management
 ===================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_facility-management.png
    :alt: property editor facility management sub-tab
 

src/bonsai/docs/reference/general/3d_viewport.rst

@@ -0,0 +1,3 @@
+3D Viewport
+===========
+.. include:: /_incomplete_message.rst

src/bonsai/docs/reference/general/blender.rst

@@ -1,6 +1,6 @@
 Blender Properties
 ==================
-
+.. include:: /_incomplete_message.rst
 The default Blender scene properties moved under its own dedicated panel.
 
 For general informations about the Blender Scene Properties see the respective 

src/bonsai/docs/reference/general/hotkeys.rst

@@ -8,7 +8,7 @@ They can be found in the UI when tool is selected.
 
 
 Blender Hotkeys Overrides
--------
+-------------------------
 
 As IFC objects are special in Blender, there are some IFC operators that repeat Blender functionality,
 but ensure the changes are in sync with IFC.
@@ -33,7 +33,7 @@ For convenience, related hotkeys are overridden using their IFC versions.
 
 
 Bonsai Special Hotkeys
--------
+----------------------
 
 - :kbd:`Ctrl` + :kbd:`Shift` + :kbd:`D` - Duplicate IFC Aggregate
 - :kbd:`Ctrl` + :kbd:`Tab` - Switch Tab (in Bonsai Properties Panel)

src/bonsai/docs/reference/general/index.rst

@@ -0,0 +1,18 @@
+General
+================
+.. include:: /_incomplete_message.rst
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Contents:
+
+   topbar
+   3d_viewport
+   status_bar
+   blender
+   hotkeys
+   interface
+   outliner
+   properties
+   scene
+   switch_tab

src/bonsai/docs/reference/general/interface.rst

@@ -0,0 +1,42 @@
+Interface
+=========
+
+.. container:: location-scene
+
+   |location| Interface
+
+   .. |location| image:: /images/location-scene.svg
+
+The Bonsai interface is split into 5 main sections.
+
+.. image:: images/interface.png
+
+1. :doc:`Topbar <topbar>` - shows main application menus to open and save IFCs, import IFCs, as well as tabs to save and load customised panel layouts.
+2. :doc:`Outliner Panel <outliner>` - shows a list of all geometric objects loaded into your 3D view. Objects can be organised into collections for any purpose.
+3. :doc:`3D Viewport Panel <3d_viewport>` - shows a 3D view of your geometric objects.
+4. :doc:`Properties Panel <properties>` - shows properties about your project, non-geometric objects, and selected objects from the 3D view.
+5. :doc:`Status Bar <status_bar>` - shows useful hotkeys when a tool is active, statistics, and version information.
+
+Panels, such as the :doc:`outliner`, :doc:`3d_viewport`, and :doc:`properties` can be customised. You can click the top left icon of any panel to change the type of panel.
+
+.. image:: images/interface-panel.png
+
+You can split, merge, or create new panels by clicking :kbd:`RMB` in-between panels.
+
+.. image:: images/interface-split-merge.png
+
+You can save panel layouts, or switch to another customised panel layout by clicking the tabs in the :doc:`topbar`. Bonsai's default layout is stored in the **BIM** tab.
+
+.. tip::
+
+   Depending on your screen size, you may need to use the mouse wheel to scroll through the workspaces or, if you press the mouse wheel, you can drag the workspaces to see them all.
+
+.. image:: images/interface-tabs.png
+
+The :doc:`Topbar <topbar>` and :doc:`status_bar` cannot be customised.
+
+.. seealso::
+
+    Bonsai's interface is a customised version of the default Blender
+    interface. Read more about `Blender Workspaces
+    <https://docs.blender.org/manual/en/latest/interface/window_system/workspaces.html>`__.

src/bonsai/docs/reference/general/outliner.rst

@@ -0,0 +1,4 @@
+Outliner
+========
+
+.. include:: /_incomplete_message.rst

src/bonsai/docs/reference/general/status_bar.rst

@@ -0,0 +1,3 @@
+Status Bar
+==========
+.. include:: /_incomplete_message.rst

src/bonsai/docs/reference/general/switch_tab.rst

@@ -1,4 +1,4 @@
 Switch Tab
 ==========
-
+.. include:: /_incomplete_message.rst
 Switch Tab button provides quick access to switch between the last 2 used Property panels

src/bonsai/docs/reference/general/topbar.rst

@@ -1,12 +1,12 @@
 Topbar
 ======
+.. |location| image:: /images/location-scene.svg
+.. |>| image:: /images/location-breadcrumb.svg
 
 .. container:: location-scene
 
    |location| Topbar
 
-   .. |location| image:: /images/location-scene.svg
-
 .. seealso::
 
     See more documentation about the `Blender Topbar <https://docs.blender.org/manual/en/latest/interface/window_system/topbar.html>`__.
@@ -18,20 +18,17 @@ File
 
    |location| Topbar |>| File
 
-   .. |location| image:: /images/location-scene.svg
-   .. |>| image:: /images/location-breadcrumb.svg
-
 Access new, open, save, and import functionality.
 
 .. image:: images/topbar-file.png
 
-- :ref:`reference/topbar:new ifc project` (:kbd:`Ctrl` + :kbd:`N`): Provides convenient presets to create new IFC projects.
+- :ref:`reference/general/topbar:new ifc project` (:kbd:`Ctrl` + :kbd:`N`): Provides convenient presets to create new IFC projects.
 - **Open IFC Project**: Launches a file browser to open an IFC model for viewing and authoring.
-- :ref:`reference/topbar:open recent ifc project`: See recently opened IFC models.
+- :ref:`reference/general/topbar:open recent ifc project`: See recently opened IFC models.
 - **Save IFC Project** (:kbd:`Shift` + :kbd:`S`): saves the ``.ifc`` file, optionally launching a file browse dialog if the file has not yet been saved.
 - **Save IFC Project As**: launches a file browse dialog to save the ``.ifc``. This location is remembered for future saves.
 - **Revert IFC Project**: Discards all unsaved changes and reloads the currently loaded IFC model.
-- :ref:`reference/topbar:import`: Imports data from external sources into the Blender session or IFC model.
+- :ref:`reference/general/topbar:import`: Imports data from external sources into the Blender session or IFC model.
 
 .. warning::
 
@@ -43,14 +40,10 @@ Access new, open, save, and import functionality.
 
 New IFC Project
 ---------------
-
 .. container:: location-scene
 
    |location| Topbar |>| File |>| New IFC Project (:kbd:`Shift` + :kbd:`N`)
 
-   .. |location| image:: /images/location-scene.svg
-   .. |>| image:: /images/location-breadcrumb.svg
-
 Provides convenient presets to create new IFC projects.
 
 .. image:: images/topbar-file-new.png
@@ -59,7 +52,7 @@ Provides convenient presets to create new IFC projects.
 - **New Metric (mm) Project**: Creates a new IFC4 project using millimeters as the length unit.
 - **New Imperial (ft) Project**: Creates a new IFC4 project using feet as the length unit.
 - **New Demo Project**: Creates a new IFC4 project with pre-populated demo types and content. Useful for experimenting and learning.
-- **New Project Wizard**: Resets the Blender session and shows the :ref:`viewing/project_overview:new project wizard` panel to customise project creation settings such as schema version.
+- **New Project Wizard**: Resets the Blender session and shows the `new project wizard` panel to customise project creation settings such as schema version.
 
 Open Recent IFC Project
 -----------------------
@@ -68,9 +61,6 @@ Open Recent IFC Project
 
    |location| Topbar |>| File |>| Open Recent IFC Project
 
-   .. |location| image:: /images/location-scene.svg
-   .. |>| image:: /images/location-breadcrumb.svg
-
 Shows a list of recently opened IFC models.
 
 - **Clear Recent IFC Projects List**: Clears the list of recently opened IFC models.
@@ -84,9 +74,6 @@ Import
 
    |location| Topbar |>| File |>| Import
 
-   .. |location| image:: /images/location-scene.svg
-   .. |>| image:: /images/location-breadcrumb.svg
-
 Imports data from external sources into the Blender session or IFC model.
 
 .. image:: images/topbar-file-import.png

src/bonsai/docs/reference/interface.rst

@@ -1,42 +0,0 @@
-Interface
-=========
-
-.. container:: location-scene
-
-   |location| Interface
-
-   .. |location| image:: /images/location-scene.svg
-
-The Bonsai interface is split into 5 main sections.
-
-.. image:: images/interface.png
-
-1. :doc:`Topbar </reference/topbar>` - shows main application menus to open and save IFCs, import IFCs, as well as tabs to save and load customised panel layouts.
-2. :doc:`Outliner Panel </reference/outliner>` - shows a list of all geometric objects loaded into your 3D view. Objects can be organised into collections for any purpose.
-3. :doc:`3D Viewport Panel </reference/3d_viewport>` - shows a 3D view of your geometric objects.
-4. :doc:`Properties Panel </reference/properties>` - shows properties about your project, non-geometric objects, and selected objects from the 3D view.
-5. :doc:`Status Bar </reference/status_bar>` - shows useful hotkeys when a tool is active, statistics, and version information.
-
-Panels, such as the :doc:`/reference/outliner`, :doc:`/reference/3d_viewport`, and :doc:`/reference/properties` can be customised. You can click the top left icon of any panel to change the type of panel.
-
-.. image:: images/interface-panel.png
-
-You can split, merge, or create new panels by clicking :kbd:`RMB` in-between panels.
-
-.. image:: images/interface-split-merge.png
-
-You can save panel layouts, or switch to another customised panel layout by clicking the tabs in the :doc:`/reference/topbar`. Bonsai's default layout is stored in the **BIM** tab.
-
-.. tip::
-
-   Depending on your screen size, you may need to use the mouse wheel to scroll through the workspaces or, if you press the mouse wheel, you can drag the workspaces to see them all.
-
-.. image:: images/interface-tabs.png
-
-The :doc:`Topbar </reference/topbar>` and :doc:`/reference/status_bar` cannot be customised.
-
-.. seealso::
-
-    Bonsai's interface is a customised version of the default Blender
-    interface. Read more about `Blender Workspaces
-    <https://docs.blender.org/manual/en/latest/interface/window_system/workspaces.html>`__.

src/bonsai/docs/reference/object_information/index.rst

@@ -1,6 +1,9 @@
 Object Information
 ==================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_object-information.png
    :alt: property editor object information sub-tab
 

src/bonsai/docs/reference/project_overview/index.rst

@@ -8,6 +8,9 @@ Project Overview
    .. |location| image:: /images/location-scene.svg
    .. |>| image:: /images/location-breadcrumb.svg
 
+
+.. include:: /_incomplete_message.rst
+
 The Project Overview sub-tab in the Bonsai interface provides a central hub
 for accessing and managing essential information and settings related to an IFC project.
 Located within the Scene Properties tab of Property Editor, this sub-tab is organized into several panels, each focusing on a specific aspect of the project.

src/bonsai/docs/reference/project_overview/project_info.rst

@@ -239,7 +239,7 @@ Advanced Loading Mode
 ---------------------
 
 .. seealso::
-  :ref:`users/advanced/dealing_with_large_models:Filtered model loading`.
+  :ref:`guides/viewing/dealing_with_large_models:Filtered model loading`.
 
 The Advanced Loading Mode is an additional mode that is available when loading an IFC file using the **Enable Advanced Mode** checkbox.
 

src/bonsai/docs/reference/quality_and_coordination/index.rst

@@ -1,6 +1,9 @@
 Quality and Coordination
 ========================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_quality-coordination.png
    :alt: property editor quality and coordination sub-tab
 

src/bonsai/docs/reference/services_and_systems/index.rst

@@ -1,6 +1,9 @@
 Services and Systems
 ====================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_services-systems.png
    :alt: property editor services and systems sub-tab
 

src/bonsai/docs/reference/structural_analysis/index.rst

@@ -1,6 +1,9 @@
 Structural Analysis
 ===================
 
+.. include:: /_incomplete_message.rst
+
+
 .. figure:: images/interface_property-editor_structural-analysis.png
    :alt: property editor structural analysis sub-tab
 

src/bonsai/docs/reference/toolbar/annotation.rst

@@ -2,6 +2,9 @@
 
 Annotation Tool
 ---------------
+
+.. include:: /_incomplete_message.rst
+    
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`7`
 
 Use this to add various types of annotations to your model, such as text, dimensions, and markers.

src/bonsai/docs/reference/toolbar/beam.rst

@@ -2,6 +2,8 @@
 
 Create Beam
 -----------
+.. include:: /_incomplete_message.rst
+    
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`0`
 
 Use this tool to add structural beam elements to your model. You can define beam profiles, lengths, and materials.

src/bonsai/docs/reference/toolbar/column.rst

@@ -2,6 +2,9 @@
 
 Create Column
 -------------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`9`
 
 Use this tool to add vertical structural elements like columns or pillars to your model.

src/bonsai/docs/reference/toolbar/covering.rst

@@ -2,6 +2,9 @@
 
 Covering Tool
 -------------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`0`
 
 This tool is used for adding surface coverings to elements, such as wall finishes, flooring, and ceiling treatments.

src/bonsai/docs/reference/toolbar/door.rst

@@ -2,6 +2,9 @@
 
 Create Door
 -----------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`7`
 
 The Create Door tool allows you to insert door elements into walls. You can choose from various door types and adjust dimensions.

src/bonsai/docs/reference/toolbar/duct.rst

@@ -2,6 +2,10 @@
 
 Create Duct
 -----------
+
+.. include:: /_incomplete_message.rst
+
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`2`
 
 This tool is used for creating HVAC ductwork. You can specify duct sizes, shapes, and routing.

src/bonsai/docs/reference/toolbar/element.rst

@@ -2,6 +2,9 @@
 
 Create Element
 --------------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`6`
 
 A generic tool for creating custom IFC elements. This is useful for elements that don't have a specific creation tool.

src/bonsai/docs/reference/toolbar/slab.rst

@@ -2,6 +2,9 @@
 
 Create Slab
 -----------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`6`
 
 Use this tool to add floor or roof slabs to your model. You can define the thickness, span, and structural properties.

src/bonsai/docs/reference/toolbar/spatial.rst

@@ -2,6 +2,9 @@
 
 Spatial Tool
 ------------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`8`
 
 This tool helps in defining and managing spatial structures within your BIM model, such as buildings, stories, and spaces.

src/bonsai/docs/reference/toolbar/structural.rst

@@ -2,6 +2,9 @@
 
 Structural Tool
 ---------------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`9`
 
 Use this for creating and editing structural elements beyond basic beams, such as columns, trusses, and reinforcements.

src/bonsai/docs/reference/toolbar/window.rst

@@ -3,6 +3,9 @@
 
 Create Window
 -------------
+
+.. include:: /_incomplete_message.rst
+
 Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`8`
 
 Similar to the door tool, this allows you to add windows to your walls. You can specify window types, sizes, and placement.