From f9dc7d5d9432d51f992f44af0888f8c361473639 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Mell=C3=BCh?= <74136980+c-mellueh@users.noreply.github.com> Date: Mon, 18 Aug 2025 08:14:06 +0200 Subject: [PATCH] Improve docs (#7005) --- src/bonsai/docs/_incomplete_message.rst | 5 ++ .../georeferencing.rst | 0 .../images/blenderoffset.png | Bin .../images/coordinateconversion.png | Bin .../images/manualorigin.png | Bin .../images/mapconversion.png | Bin .../images/mapcoordinates.png | Bin .../images/offsetmode.png | Bin .../images/projectedcrs.png | Bin .../images/truenorth.png | Bin .../images/xaxisabscissaordinate.png | Bin .../authoring/advanced_modeling/index.rst | 34 ++++++++++ .../material_assignment.rst | 1 + .../parametric_geometry.rst | 3 +- .../{ => basic_modeling}/creating_walls.rst | 0 .../defining_rooms_spaces.rst | 3 +- .../authoring/{ => basic_modeling}/door.rst | 4 +- .../guides/authoring/basic_modeling/index.rst | 55 +++++++++++++++ .../modeling_slabs_roofs.rst | 3 +- .../{ => basic_modeling}/opening.rst | 2 +- .../authoring/{ => basic_modeling}/window.rst | 4 +- src/bonsai/docs/guides/authoring/index.rst | 16 ++--- .../guides/authoring/starting_new_project.rst | 4 +- .../classification_and_types.rst | 2 +- .../geometry_and_representations.rst | 0 .../index.rst} | 0 .../spatial_objects.rst | 2 +- .../working_with_representations.rst | 0 src/bonsai/docs/guides/coordination/index.rst | 3 +- .../guides/costing_and_scheduling/index.rst | 7 +- .../docs/guides/development/code_style.rst | 1 + .../docs/guides/development/debugging.rst | 4 +- .../guides/development/getting_started.rst | 4 +- .../ide/bonsai_style_annotation.svg | 0 .../development}/ide/images/GitHubUser.png | Bin .../ide/images/VSCode-and-blender.png | Bin ...blender-additional-arguments-2-windows.png | Bin ...ode-blender-additional-arguments-linux.png | Bin ...e-blender-additional-arguments-windows.png | Bin .../VSCode-blender-extension-settings.png | Bin .../ide/images/VSCode-blender-extension.png | Bin .../ide/images/VSCode-blender-start.png | Bin .../ide/images/VSCode-extensions.png | Bin .../images/VSCode-python-version-linux.png | Bin .../images/VSCode-python-version-windows.png | Bin .../ide/images/blender-installation-1.png | Bin .../ide/images/blender-installation-2.png | Bin .../ide/images/blender-python-version.png | Bin .../ide/images/blender_development_addons.png | Bin .../images/blender_experimental_debugging.png | Bin .../ide/images/bonsai-doc-server.png | Bin .../ide/images/bonsai-layout2.png | Bin .../development}/ide/images/bonsai_debug.png | Bin .../ide/images/break-point-stop.png | Bin .../development}/ide/images/break-point.png | Bin .../development}/ide/images/check-fork.png | Bin .../images/checkout_pull_request_vscode.png | Bin .../development}/ide/images/cloned-repo.png | Bin .../ide/images/cloning-from-github.png | Bin .../ide/images/commit-changes-linux.png | Bin .../ide/images/commit-changes-windows.png | Bin .../ide/images/compare-and-pull-request.png | Bin .../development}/ide/images/create-branch.png | Bin .../development}/ide/images/create-user.png | Bin .../images/dev-environment-sh-executed.png | Bin .../ide/images/dev-environment-sh.png | Bin .../development}/ide/images/doc-pip-furo.png | Bin .../ide/images/doc-server-running.png | Bin .../development}/ide/images/edit_source.png | Bin .../ide/images/enable-developer-extras.png | Bin .../ide/images/environment-variables.png | Bin .../development}/ide/images/fork-bonsai.png | Bin .../development}/ide/images/forked-bonsai.png | Bin .../ide/images/git-user-email-linux.png | Bin .../ide/images/git-user-email-windows.png | Bin .../images/inkscape-annotation-template.png | Bin .../ide/images/inkscape-scaling-outline.png | Bin .../ide/images/install-bpy-fake-linux.png | Bin .../ide/images/install-bpy-fake-windows.png | Bin .../ide/images/install-python-1.png | Bin .../ide/images/install-python-2.png | Bin .../ide/images/install-python-3.png | Bin .../ide/images/install-python-4.png | Bin .../ide/images/install-python-5.png | Bin .../ide/images/install-python-6.png | Bin .../ide/images/install-vscode.png | Bin .../ide/images/just-my-code-false.png | Bin .../ide/images/launch-linux-jason.png | Bin .../ide/images/launch-terminal.png | Bin .../ide/images/launch-windows-jason.png | Bin .../ide/images/make-changes-linux.png | Bin .../ide/images/make-changes-windows.png | Bin .../development}/ide/images/marked_code.png | Bin .../images/new-branch-in-private-github.png | Bin .../ide/images/new-branch-local.png | Bin .../new-branch-publish-to-private-github.png | Bin .../ide/images/print-to-console.png | Bin .../private-fork-new-branch-updated-linux.png | Bin ...rivate-fork-new-branch-updated-windows.png | Bin .../development}/ide/images/pull-changes.png | Bin .../ide/images/pull-request-linux.png | Bin .../ide/images/pull-request-windows.png | Bin .../ide/images/pull_request_see.png | Bin .../push-to-private-fork-new-branch.png | Bin .../ide/images/python-downloads.png | Bin .../ide/images/python-version.png | Bin .../development}/ide/images/rebase_branch.png | Bin .../ide/images/restart-blender.png | Bin .../ide/images/run-as-administrator.png | Bin .../images/running-dev_environment-bat.png | Bin .../ide/images/script-blender-vscode-2.png | Bin .../ide/images/script-blender-vscode.png | Bin .../ide/images/scripting_ui_code.png | Bin .../ide/images/selecting-forked-repo.png | Bin .../ide/images/staging-prior-commit.png | Bin .../ide/images/step-over-linux.png | Bin .../development}/ide/images/step-over.png | Bin .../development}/ide/images/sync-fork.png | Bin .../ide/images/tasks-linux-jason.png | Bin .../ide/images/tasks-windows-jason.png | Bin .../images/terminal-integrated-windows.png | Bin .../ide/images/trigger-breakpoint.png | Bin .../ide/images/vscode_search_in_files.png | Bin .../ide/images/vscode_search_results.png | Bin .../development}/ide/images/win-add-user.png | Bin .../development}/ide/images/windows-path.png | Bin .../development}/ide/index.rst | 2 +- .../development}/ide/linux/dev_environment.sh | 0 .../development}/ide/linux/launch.json | 0 .../development}/ide/linux/tasks.json | 0 .../development}/ide/linux_ide.rst | 0 .../development}/ide/macos_ide.rst | 2 +- .../ide/windows/dev_environment.bat | 0 .../development}/ide/windows/launch.json | 0 .../development}/ide/windows/tasks.json | 0 .../development}/ide/windows_ide.rst | 0 src/bonsai/docs/guides/development/index.rst | 4 ++ .../docs/guides/development/writing_docs.rst | 12 +++- src/bonsai/docs/guides/drawings/index.rst | 2 +- .../docs/guides/facility_management/index.rst | 3 +- src/bonsai/docs/guides/services/index.rst | 3 +- .../docs/guides/structural_analysis/index.rst | 7 +- .../viewing/dealing_with_large_models.rst | 2 +- src/bonsai/docs/guides/viewing/index.rst | 2 +- src/bonsai/docs/index.rst | 38 +++++++---- src/bonsai/docs/quickstart/next_steps.rst | 4 +- .../costing_and_scheduling/index.rst | 3 + .../drawings_and_documents/index.rst | 3 + .../reference/facility_management/index.rst | 3 + .../docs/reference/general/3d_viewport.rst | 3 + .../docs/reference/{ => general}/blender.rst | 2 +- .../docs/reference/{ => general}/hotkeys.rst | 4 +- .../{ => general}/images/interface-panel.png | Bin .../images/interface-split-merge.png | Bin .../{ => general}/images/interface-tabs.png | Bin .../{ => general}/images/interface.png | Bin .../{ => general}/images/properties-tabs.png | Bin .../images/topbar-file-import.png | Bin .../{ => general}/images/topbar-file-new.png | Bin .../images/topbar-file-recent.png | Bin .../{ => general}/images/topbar-file.png | Bin src/bonsai/docs/reference/general/index.rst | 18 +++++ .../docs/reference/general/interface.rst | 42 ++++++++++++ .../docs/reference/general/outliner.rst | 4 ++ .../reference/{ => general}/properties.rst | 0 .../docs/reference/{ => general}/scene.rst | 0 .../docs/reference/general/status_bar.rst | 3 + .../reference/{ => general}/switch_tab.rst | 2 +- .../docs/reference/{ => general}/topbar.rst | 25 ++----- src/bonsai/docs/reference/interface.rst | 42 ------------ .../reference/object_information/index.rst | 3 + .../docs/reference/project_overview/index.rst | 3 + .../project_overview/project_info.rst | 2 +- .../quality_and_coordination/index.rst | 3 + .../reference/services_and_systems/index.rst | 3 + .../reference/structural_analysis/index.rst | 3 + .../docs/reference/toolbar/annotation.rst | 3 + src/bonsai/docs/reference/toolbar/beam.rst | 2 + src/bonsai/docs/reference/toolbar/column.rst | 3 + .../docs/reference/toolbar/covering.rst | 3 + src/bonsai/docs/reference/toolbar/door.rst | 3 + src/bonsai/docs/reference/toolbar/duct.rst | 4 ++ src/bonsai/docs/reference/toolbar/element.rst | 3 + src/bonsai/docs/reference/toolbar/slab.rst | 3 + src/bonsai/docs/reference/toolbar/spatial.rst | 3 + .../docs/reference/toolbar/structural.rst | 3 + src/bonsai/docs/reference/toolbar/window.rst | 3 + src/bonsai/docs/tutorials/index.rst | 63 ++++++++++++++++++ src/bonsai/docs/tutorials/project0.rst | 6 +- src/bonsai/docs/tutorials/project1.rst | 5 +- src/bonsai/docs/tutorials/project2.rst | 4 +- src/bonsai/docs/tutorials/project3.rst | 2 + src/bonsai/docs/tutorials/project4.rst | 2 + src/bonsai/docs/tutorials/project5.rst | 2 + 194 files changed, 388 insertions(+), 138 deletions(-) create mode 100644 src/bonsai/docs/_incomplete_message.rst rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/georeferencing.rst (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/blenderoffset.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/coordinateconversion.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/manualorigin.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/mapconversion.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/mapcoordinates.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/offsetmode.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/projectedcrs.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/truenorth.png (100%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/images/xaxisabscissaordinate.png (100%) create mode 100644 src/bonsai/docs/guides/authoring/advanced_modeling/index.rst rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/material_assignment.rst (98%) rename src/bonsai/docs/guides/authoring/{ => advanced_modeling}/parametric_geometry.rst (97%) rename src/bonsai/docs/guides/authoring/{ => basic_modeling}/creating_walls.rst (100%) rename src/bonsai/docs/guides/authoring/{ => basic_modeling}/defining_rooms_spaces.rst (51%) rename src/bonsai/docs/guides/authoring/{ => basic_modeling}/door.rst (98%) create mode 100644 src/bonsai/docs/guides/authoring/basic_modeling/index.rst rename src/bonsai/docs/guides/authoring/{ => basic_modeling}/modeling_slabs_roofs.rst (51%) rename src/bonsai/docs/guides/authoring/{ => basic_modeling}/opening.rst (98%) rename src/bonsai/docs/guides/authoring/{ => basic_modeling}/window.rst (98%) rename src/bonsai/docs/guides/authoring/{ => understanding_ifc}/classification_and_types.rst (75%) rename src/bonsai/docs/guides/authoring/{ => understanding_ifc}/geometry_and_representations.rst (100%) rename src/bonsai/docs/guides/authoring/{understanding_ifc.rst => understanding_ifc/index.rst} (100%) rename src/bonsai/docs/guides/authoring/{ => understanding_ifc}/spatial_objects.rst (82%) rename src/bonsai/docs/guides/authoring/{ => understanding_ifc}/working_with_representations.rst (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/bonsai_style_annotation.svg (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/GitHubUser.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-and-blender.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-blender-additional-arguments-2-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-blender-additional-arguments-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-blender-additional-arguments-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-blender-extension-settings.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-blender-extension.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-blender-start.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-extensions.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-python-version-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/VSCode-python-version-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/blender-installation-1.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/blender-installation-2.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/blender-python-version.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/blender_development_addons.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/blender_experimental_debugging.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/bonsai-doc-server.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/bonsai-layout2.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/bonsai_debug.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/break-point-stop.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/break-point.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/check-fork.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/checkout_pull_request_vscode.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/cloned-repo.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/cloning-from-github.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/commit-changes-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/commit-changes-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/compare-and-pull-request.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/create-branch.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/create-user.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/dev-environment-sh-executed.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/dev-environment-sh.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/doc-pip-furo.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/doc-server-running.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/edit_source.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/enable-developer-extras.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/environment-variables.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/fork-bonsai.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/forked-bonsai.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/git-user-email-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/git-user-email-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/inkscape-annotation-template.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/inkscape-scaling-outline.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-bpy-fake-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-bpy-fake-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-python-1.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-python-2.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-python-3.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-python-4.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-python-5.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-python-6.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/install-vscode.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/just-my-code-false.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/launch-linux-jason.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/launch-terminal.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/launch-windows-jason.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/make-changes-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/make-changes-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/marked_code.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/new-branch-in-private-github.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/new-branch-local.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/new-branch-publish-to-private-github.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/print-to-console.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/private-fork-new-branch-updated-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/private-fork-new-branch-updated-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/pull-changes.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/pull-request-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/pull-request-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/pull_request_see.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/push-to-private-fork-new-branch.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/python-downloads.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/python-version.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/rebase_branch.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/restart-blender.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/run-as-administrator.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/running-dev_environment-bat.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/script-blender-vscode-2.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/script-blender-vscode.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/scripting_ui_code.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/selecting-forked-repo.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/staging-prior-commit.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/step-over-linux.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/step-over.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/sync-fork.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/tasks-linux-jason.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/tasks-windows-jason.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/terminal-integrated-windows.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/trigger-breakpoint.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/vscode_search_in_files.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/vscode_search_results.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/win-add-user.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/images/windows-path.png (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/index.rst (91%) rename src/bonsai/docs/{quickstart => guides/development}/ide/linux/dev_environment.sh (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/linux/launch.json (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/linux/tasks.json (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/linux_ide.rst (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/macos_ide.rst (80%) rename src/bonsai/docs/{quickstart => guides/development}/ide/windows/dev_environment.bat (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/windows/launch.json (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/windows/tasks.json (100%) rename src/bonsai/docs/{quickstart => guides/development}/ide/windows_ide.rst (100%) create mode 100644 src/bonsai/docs/reference/general/3d_viewport.rst rename src/bonsai/docs/reference/{ => general}/blender.rst (89%) rename src/bonsai/docs/reference/{ => general}/hotkeys.rst (96%) rename src/bonsai/docs/reference/{ => general}/images/interface-panel.png (100%) rename src/bonsai/docs/reference/{ => general}/images/interface-split-merge.png (100%) rename src/bonsai/docs/reference/{ => general}/images/interface-tabs.png (100%) rename src/bonsai/docs/reference/{ => general}/images/interface.png (100%) rename src/bonsai/docs/reference/{ => general}/images/properties-tabs.png (100%) rename src/bonsai/docs/reference/{ => general}/images/topbar-file-import.png (100%) rename src/bonsai/docs/reference/{ => general}/images/topbar-file-new.png (100%) rename src/bonsai/docs/reference/{ => general}/images/topbar-file-recent.png (100%) rename src/bonsai/docs/reference/{ => general}/images/topbar-file.png (100%) create mode 100644 src/bonsai/docs/reference/general/index.rst create mode 100644 src/bonsai/docs/reference/general/interface.rst create mode 100644 src/bonsai/docs/reference/general/outliner.rst rename src/bonsai/docs/reference/{ => general}/properties.rst (100%) rename src/bonsai/docs/reference/{ => general}/scene.rst (100%) create mode 100644 src/bonsai/docs/reference/general/status_bar.rst rename src/bonsai/docs/reference/{ => general}/switch_tab.rst (74%) rename src/bonsai/docs/reference/{ => general}/topbar.rst (78%) delete mode 100644 src/bonsai/docs/reference/interface.rst create mode 100644 src/bonsai/docs/tutorials/index.rst diff --git a/src/bonsai/docs/_incomplete_message.rst b/src/bonsai/docs/_incomplete_message.rst new file mode 100644 index 0000000000..83bbf8fc0e --- /dev/null +++ b/src/bonsai/docs/_incomplete_message.rst @@ -0,0 +1,5 @@ +.. admonition:: 🚧 **Work in Progress** + + | This page is **incomplete**. + | read :doc:`/guides/development/writing_docs` to learn how to contributing missing content, examples or fixes. + | Thank you! \ No newline at end of file diff --git a/src/bonsai/docs/guides/authoring/georeferencing.rst b/src/bonsai/docs/guides/authoring/advanced_modeling/georeferencing.rst similarity index 100% rename from src/bonsai/docs/guides/authoring/georeferencing.rst rename to src/bonsai/docs/guides/authoring/advanced_modeling/georeferencing.rst diff --git a/src/bonsai/docs/guides/authoring/images/blenderoffset.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/blenderoffset.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/blenderoffset.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/blenderoffset.png diff --git a/src/bonsai/docs/guides/authoring/images/coordinateconversion.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/coordinateconversion.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/coordinateconversion.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/coordinateconversion.png diff --git a/src/bonsai/docs/guides/authoring/images/manualorigin.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/manualorigin.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/manualorigin.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/manualorigin.png diff --git a/src/bonsai/docs/guides/authoring/images/mapconversion.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/mapconversion.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/mapconversion.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/mapconversion.png diff --git a/src/bonsai/docs/guides/authoring/images/mapcoordinates.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/mapcoordinates.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/mapcoordinates.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/mapcoordinates.png diff --git a/src/bonsai/docs/guides/authoring/images/offsetmode.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/offsetmode.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/offsetmode.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/offsetmode.png diff --git a/src/bonsai/docs/guides/authoring/images/projectedcrs.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/projectedcrs.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/projectedcrs.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/projectedcrs.png diff --git a/src/bonsai/docs/guides/authoring/images/truenorth.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/truenorth.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/truenorth.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/truenorth.png diff --git a/src/bonsai/docs/guides/authoring/images/xaxisabscissaordinate.png b/src/bonsai/docs/guides/authoring/advanced_modeling/images/xaxisabscissaordinate.png similarity index 100% rename from src/bonsai/docs/guides/authoring/images/xaxisabscissaordinate.png rename to src/bonsai/docs/guides/authoring/advanced_modeling/images/xaxisabscissaordinate.png diff --git a/src/bonsai/docs/guides/authoring/advanced_modeling/index.rst b/src/bonsai/docs/guides/authoring/advanced_modeling/index.rst new file mode 100644 index 0000000000..56d5faa19e --- /dev/null +++ b/src/bonsai/docs/guides/authoring/advanced_modeling/index.rst @@ -0,0 +1,34 @@ +Advanced Modeling +================= + +This chapter covers the advanced aspects of working with Bonsai. It is divided into three main sections: + +.. only:: builder_html and (not singlehtml) + + .. container:: toc-cards + + .. container:: card + + :doc:`georeferencing` + This section covers how to georeference models and work with georeferenced models + + .. container:: card + + :doc:`parametric_geometry` + Bonsai provides tools for creating and editing parametric geometry for IFC elements. + Parametric geometry allows you to define building elements using parameters that can be easily adjusted, rather than modeling fixed geometry. + This Page shows you how to create parametric geometries + + .. container:: card + + :doc:`material_assignment` + This section covers how to assign and customize materials in your BIM model using the Bonsai. +.. container:: global-index-toc + + .. toctree:: + :hidden: + :maxdepth: 2 + + georeferencing + parametric_geometry + material_assignment diff --git a/src/bonsai/docs/guides/authoring/material_assignment.rst b/src/bonsai/docs/guides/authoring/advanced_modeling/material_assignment.rst similarity index 98% rename from src/bonsai/docs/guides/authoring/material_assignment.rst rename to src/bonsai/docs/guides/authoring/advanced_modeling/material_assignment.rst index 010fc715ff..7bb9d4297a 100644 --- a/src/bonsai/docs/guides/authoring/material_assignment.rst +++ b/src/bonsai/docs/guides/authoring/advanced_modeling/material_assignment.rst @@ -1,5 +1,6 @@ Material Assignment =================== +.. include:: /_incomplete_message.rst This section covers how to assign and customize materials in your BIM model using the Bonsai. diff --git a/src/bonsai/docs/guides/authoring/parametric_geometry.rst b/src/bonsai/docs/guides/authoring/advanced_modeling/parametric_geometry.rst similarity index 97% rename from src/bonsai/docs/guides/authoring/parametric_geometry.rst rename to src/bonsai/docs/guides/authoring/advanced_modeling/parametric_geometry.rst index 842595c4f6..996bb272fb 100644 --- a/src/bonsai/docs/guides/authoring/parametric_geometry.rst +++ b/src/bonsai/docs/guides/authoring/advanced_modeling/parametric_geometry.rst @@ -1,6 +1,7 @@ Parametric Geometry =================== - +.. include:: /_incomplete_message.rst + Bonsai provides tools for creating and editing parametric geometry for IFC elements. Parametric geometry allows you to define building elements using parameters that can be easily adjusted, rather than modeling fixed geometry. diff --git a/src/bonsai/docs/guides/authoring/creating_walls.rst b/src/bonsai/docs/guides/authoring/basic_modeling/creating_walls.rst similarity index 100% rename from src/bonsai/docs/guides/authoring/creating_walls.rst rename to src/bonsai/docs/guides/authoring/basic_modeling/creating_walls.rst diff --git a/src/bonsai/docs/guides/authoring/defining_rooms_spaces.rst b/src/bonsai/docs/guides/authoring/basic_modeling/defining_rooms_spaces.rst similarity index 51% rename from src/bonsai/docs/guides/authoring/defining_rooms_spaces.rst rename to src/bonsai/docs/guides/authoring/basic_modeling/defining_rooms_spaces.rst index 79d37c2e58..af6f60af3f 100644 --- a/src/bonsai/docs/guides/authoring/defining_rooms_spaces.rst +++ b/src/bonsai/docs/guides/authoring/basic_modeling/defining_rooms_spaces.rst @@ -1,7 +1,6 @@ Defining Rooms and Spaces ========================= -.. note:: - This page is a stub. More detailed content will be added in future updates. +.. include:: /_incomplete_message.rst [Content about defining rooms and spaces] diff --git a/src/bonsai/docs/guides/authoring/door.rst b/src/bonsai/docs/guides/authoring/basic_modeling/door.rst similarity index 98% rename from src/bonsai/docs/guides/authoring/door.rst rename to src/bonsai/docs/guides/authoring/basic_modeling/door.rst index 72a843d3e6..501d771d6e 100644 --- a/src/bonsai/docs/guides/authoring/door.rst +++ b/src/bonsai/docs/guides/authoring/basic_modeling/door.rst @@ -150,5 +150,5 @@ To create multiple doors of the same type: See Also -------- -- :doc:`../creating_walls` -- :doc:`../../advanced_modeling/material_assignment` +- :doc:`creating_walls` +- :doc:`../advanced_modeling/material_assignment` diff --git a/src/bonsai/docs/guides/authoring/basic_modeling/index.rst b/src/bonsai/docs/guides/authoring/basic_modeling/index.rst new file mode 100644 index 0000000000..f1e18e3e3d --- /dev/null +++ b/src/bonsai/docs/guides/authoring/basic_modeling/index.rst @@ -0,0 +1,55 @@ +Basic Modeling +================ + +This chapter covers the basic aspects of creating Entities for Industry Foundation Classes (IFC) in Bonsai. It is divided into seven main sections: + +.. only:: builder_html and (not singlehtml) + + .. container:: toc-cards + + .. container:: card + + :doc:`creating_walls` + Walls are fundamental elements in any building design. Bonsai provides powerful tools for creating and manipulating wall elements. + This section will guide you through the process of creating standalone walls, multiple connected walls, and joining walls using various techniques. + + + .. container:: card + + :doc:`defining_rooms_spaces` + This section will help you Creating Rooms and Spaces + + .. container:: card + + :doc:`opening` + This section covers how to create openings without fillings in your BIM model using Bonsai. + + .. container:: card + + :doc:`door` + This section covers how to add and customize doors in your BIM model using Bonsai. + + .. container:: card + + :doc:`modeling_slabs_roofs` + This section covers how to model slabs and roofs + + + + + + + +.. container:: global-index-toc + + .. toctree:: + :hidden: + :maxdepth: 2 + + creating_walls + defining_rooms_spaces + opening + door + window + modeling_slabs_roofs + diff --git a/src/bonsai/docs/guides/authoring/modeling_slabs_roofs.rst b/src/bonsai/docs/guides/authoring/basic_modeling/modeling_slabs_roofs.rst similarity index 51% rename from src/bonsai/docs/guides/authoring/modeling_slabs_roofs.rst rename to src/bonsai/docs/guides/authoring/basic_modeling/modeling_slabs_roofs.rst index a11ea80a47..8785726ca5 100644 --- a/src/bonsai/docs/guides/authoring/modeling_slabs_roofs.rst +++ b/src/bonsai/docs/guides/authoring/basic_modeling/modeling_slabs_roofs.rst @@ -1,7 +1,6 @@ Modeling Slabs and Roofs ======================== -.. note:: - This page is a stub. More detailed content will be added in future updates. +.. include:: /_incomplete_message.rst [Content about modeling slabs and roofs] diff --git a/src/bonsai/docs/guides/authoring/opening.rst b/src/bonsai/docs/guides/authoring/basic_modeling/opening.rst similarity index 98% rename from src/bonsai/docs/guides/authoring/opening.rst rename to src/bonsai/docs/guides/authoring/basic_modeling/opening.rst index d5f69a5f5f..27bf71b0ef 100644 --- a/src/bonsai/docs/guides/authoring/opening.rst +++ b/src/bonsai/docs/guides/authoring/basic_modeling/opening.rst @@ -56,6 +56,6 @@ You can modify openings using various tools: See Also -------- -- :doc:`../creating_walls` +- :doc:`creating_walls` - :doc:`door` - :doc:`window` diff --git a/src/bonsai/docs/guides/authoring/window.rst b/src/bonsai/docs/guides/authoring/basic_modeling/window.rst similarity index 98% rename from src/bonsai/docs/guides/authoring/window.rst rename to src/bonsai/docs/guides/authoring/basic_modeling/window.rst index 2836cabbf1..5059bcb0df 100644 --- a/src/bonsai/docs/guides/authoring/window.rst +++ b/src/bonsai/docs/guides/authoring/basic_modeling/window.rst @@ -141,5 +141,5 @@ This will update the quantity information for the selected elements. See Also -------- -- :doc:`../creating_walls` -- :doc:`../../advanced_modeling/material_assignment` +- :doc:`creating_walls` +- :doc:`../advanced_modeling/material_assignment` diff --git a/src/bonsai/docs/guides/authoring/index.rst b/src/bonsai/docs/guides/authoring/index.rst index 157bce093a..f4e6c56980 100644 --- a/src/bonsai/docs/guides/authoring/index.rst +++ b/src/bonsai/docs/guides/authoring/index.rst @@ -9,20 +9,12 @@ This chapter covers the essential aspects of working with Industry Foundation Cl .. container:: card - :doc:`understanding_ifc` + :doc:`understanding_ifc/index` An introduction to IFC standards, schemas, and concepts. This section explains the structure of IFC data, key spatial objects, and the role of organizations like buildingSMART in maintaining IFC standards. It also covers IfcOpenShell and the broader ecosystem of open standards in the AEC industry. - - .. container:: card - - :doc:`importing_viewing_models` - A guide on how to import existing IFC models into Bonsai and navigate them effectively. - This section includes techniques for inspecting and querying IFC data within the Bonsai environment. - - .. container:: card :doc:`starting_new_project` @@ -55,6 +47,10 @@ This chapter covers the essential aspects of working with Industry Foundation Cl :hidden: :maxdepth: 2 - georeferencing + starting_new_project + understanding_ifc/index + basic_modeling/index + advanced_modeling/index git_support other_addons + diff --git a/src/bonsai/docs/guides/authoring/starting_new_project.rst b/src/bonsai/docs/guides/authoring/starting_new_project.rst index 90a6b11180..a8ad6e9b4c 100644 --- a/src/bonsai/docs/guides/authoring/starting_new_project.rst +++ b/src/bonsai/docs/guides/authoring/starting_new_project.rst @@ -139,5 +139,5 @@ Next Steps - Start defining spaces and zones within your building. .. seealso:: - - :doc:`/users/user_interface/property_editor/scene_editor/project_overview/project_info` - - :doc:`/users/user_interface/topbar` + - :doc:`/reference/project_overview/project_info` + - :doc:`/reference/general/topbar` diff --git a/src/bonsai/docs/guides/authoring/classification_and_types.rst b/src/bonsai/docs/guides/authoring/understanding_ifc/classification_and_types.rst similarity index 75% rename from src/bonsai/docs/guides/authoring/classification_and_types.rst rename to src/bonsai/docs/guides/authoring/understanding_ifc/classification_and_types.rst index cd978aded5..63e2f7d6c0 100644 --- a/src/bonsai/docs/guides/authoring/classification_and_types.rst +++ b/src/bonsai/docs/guides/authoring/understanding_ifc/classification_and_types.rst @@ -1,4 +1,4 @@ Classification and Types ======================== - +.. include:: /_incomplete_message.rst IFC classification hierarchy and the concept of types and occurrences. \ No newline at end of file diff --git a/src/bonsai/docs/guides/authoring/geometry_and_representations.rst b/src/bonsai/docs/guides/authoring/understanding_ifc/geometry_and_representations.rst similarity index 100% rename from src/bonsai/docs/guides/authoring/geometry_and_representations.rst rename to src/bonsai/docs/guides/authoring/understanding_ifc/geometry_and_representations.rst diff --git a/src/bonsai/docs/guides/authoring/understanding_ifc.rst b/src/bonsai/docs/guides/authoring/understanding_ifc/index.rst similarity index 100% rename from src/bonsai/docs/guides/authoring/understanding_ifc.rst rename to src/bonsai/docs/guides/authoring/understanding_ifc/index.rst diff --git a/src/bonsai/docs/guides/authoring/spatial_objects.rst b/src/bonsai/docs/guides/authoring/understanding_ifc/spatial_objects.rst similarity index 82% rename from src/bonsai/docs/guides/authoring/spatial_objects.rst rename to src/bonsai/docs/guides/authoring/understanding_ifc/spatial_objects.rst index 6a59de4f54..1b95259bfe 100644 --- a/src/bonsai/docs/guides/authoring/spatial_objects.rst +++ b/src/bonsai/docs/guides/authoring/understanding_ifc/spatial_objects.rst @@ -1,6 +1,6 @@ Basic Spatial Objects ===================== - +.. include:: /_incomplete_message.rst IFC organizes building information in a hierarchical structure: - IfcProject diff --git a/src/bonsai/docs/guides/authoring/working_with_representations.rst b/src/bonsai/docs/guides/authoring/understanding_ifc/working_with_representations.rst similarity index 100% rename from src/bonsai/docs/guides/authoring/working_with_representations.rst rename to src/bonsai/docs/guides/authoring/understanding_ifc/working_with_representations.rst diff --git a/src/bonsai/docs/guides/coordination/index.rst b/src/bonsai/docs/guides/coordination/index.rst index 6ff370f31c..25d6f87494 100644 --- a/src/bonsai/docs/guides/coordination/index.rst +++ b/src/bonsai/docs/guides/coordination/index.rst @@ -1,4 +1,3 @@ Coordination ============ - -TODO +.. include:: /_incomplete_message.rst diff --git a/src/bonsai/docs/guides/costing_and_scheduling/index.rst b/src/bonsai/docs/guides/costing_and_scheduling/index.rst index d8095a561e..7e1fb17ff0 100644 --- a/src/bonsai/docs/guides/costing_and_scheduling/index.rst +++ b/src/bonsai/docs/guides/costing_and_scheduling/index.rst @@ -3,8 +3,7 @@ Costing and scheduling This section covers the cost estimation and project scheduling features in Bonsai. -.. note:: - This page is a stub. More detailed content will be added in future updates. +.. include:: /_incomplete_message.rst Overview -------- @@ -31,5 +30,5 @@ To begin using the costing and scheduling features in Bonsai: 4. Link BIM elements to schedule activities .. seealso:: - - :doc:`/users/modeling/ifc_modeling` - - :doc:`/users/advanced/index` + - :doc:`/guides/authoring/index` + - :doc:`/guides/authoring/advanced_modeling/index` diff --git a/src/bonsai/docs/guides/development/code_style.rst b/src/bonsai/docs/guides/development/code_style.rst index d7f5e16471..cdc506d5ab 100644 --- a/src/bonsai/docs/guides/development/code_style.rst +++ b/src/bonsai/docs/guides/development/code_style.rst @@ -27,6 +27,7 @@ and ensure new Python syntax doesn't break code on older Python versions. ``ruff`` can be installed using ``pip install ruff`` and files can be formatted with the following example commands: .. code-block:: bash + # Check issues for the entire repository. ruff check # Apply some automatic fixes, if available. diff --git a/src/bonsai/docs/guides/development/debugging.rst b/src/bonsai/docs/guides/development/debugging.rst index a74331e1ec..b97c411fae 100644 --- a/src/bonsai/docs/guides/development/debugging.rst +++ b/src/bonsai/docs/guides/development/debugging.rst @@ -10,7 +10,7 @@ this can be expanded by others. the debugger overhead. VSCode Extension --------------- +---------------- 1. **Install VSCode/VSCodium**: This will be system specific. I used the available snap package. @@ -135,7 +135,7 @@ when troubleshooting issues, and able to make many more contributions, fixes and patches. Blender Addon + VS Code Debugger ------------------------------- +--------------------------------- Setting up debugging with Blender Addon is a bit simpler as it doesn't require Blender to be started in a special way and debugger can be always attached later when it's needed. diff --git a/src/bonsai/docs/guides/development/getting_started.rst b/src/bonsai/docs/guides/development/getting_started.rst index 7aa6495c40..a03a885b04 100644 --- a/src/bonsai/docs/guides/development/getting_started.rst +++ b/src/bonsai/docs/guides/development/getting_started.rst @@ -7,8 +7,8 @@ suggesting new features, or contributing code, your involvement is highly encour This part of the documentation covers various aspects of the Bonsai development process, including: -- :doc:`Writing User Documentation ` -- :doc:`Translations and Internationalisation ` +- :doc:`Writing User Documentation ` +- :doc:`Translations and Internationalisation ` - Contributing Code - :doc:`Installation and Setting up a Development Environment ` - Understanding the Project Structure and Codebase diff --git a/src/bonsai/docs/quickstart/ide/bonsai_style_annotation.svg b/src/bonsai/docs/guides/development/ide/bonsai_style_annotation.svg similarity index 100% rename from src/bonsai/docs/quickstart/ide/bonsai_style_annotation.svg rename to src/bonsai/docs/guides/development/ide/bonsai_style_annotation.svg diff --git a/src/bonsai/docs/quickstart/ide/images/GitHubUser.png b/src/bonsai/docs/guides/development/ide/images/GitHubUser.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/GitHubUser.png rename to src/bonsai/docs/guides/development/ide/images/GitHubUser.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-and-blender.png b/src/bonsai/docs/guides/development/ide/images/VSCode-and-blender.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-and-blender.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-and-blender.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-blender-additional-arguments-2-windows.png b/src/bonsai/docs/guides/development/ide/images/VSCode-blender-additional-arguments-2-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-blender-additional-arguments-2-windows.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-blender-additional-arguments-2-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-blender-additional-arguments-linux.png b/src/bonsai/docs/guides/development/ide/images/VSCode-blender-additional-arguments-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-blender-additional-arguments-linux.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-blender-additional-arguments-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-blender-additional-arguments-windows.png b/src/bonsai/docs/guides/development/ide/images/VSCode-blender-additional-arguments-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-blender-additional-arguments-windows.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-blender-additional-arguments-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-blender-extension-settings.png b/src/bonsai/docs/guides/development/ide/images/VSCode-blender-extension-settings.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-blender-extension-settings.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-blender-extension-settings.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-blender-extension.png b/src/bonsai/docs/guides/development/ide/images/VSCode-blender-extension.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-blender-extension.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-blender-extension.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-blender-start.png b/src/bonsai/docs/guides/development/ide/images/VSCode-blender-start.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-blender-start.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-blender-start.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-extensions.png b/src/bonsai/docs/guides/development/ide/images/VSCode-extensions.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-extensions.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-extensions.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-python-version-linux.png b/src/bonsai/docs/guides/development/ide/images/VSCode-python-version-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-python-version-linux.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-python-version-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/VSCode-python-version-windows.png b/src/bonsai/docs/guides/development/ide/images/VSCode-python-version-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/VSCode-python-version-windows.png rename to src/bonsai/docs/guides/development/ide/images/VSCode-python-version-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/blender-installation-1.png b/src/bonsai/docs/guides/development/ide/images/blender-installation-1.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/blender-installation-1.png rename to src/bonsai/docs/guides/development/ide/images/blender-installation-1.png diff --git a/src/bonsai/docs/quickstart/ide/images/blender-installation-2.png b/src/bonsai/docs/guides/development/ide/images/blender-installation-2.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/blender-installation-2.png rename to src/bonsai/docs/guides/development/ide/images/blender-installation-2.png diff --git a/src/bonsai/docs/quickstart/ide/images/blender-python-version.png b/src/bonsai/docs/guides/development/ide/images/blender-python-version.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/blender-python-version.png rename to src/bonsai/docs/guides/development/ide/images/blender-python-version.png diff --git a/src/bonsai/docs/quickstart/ide/images/blender_development_addons.png b/src/bonsai/docs/guides/development/ide/images/blender_development_addons.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/blender_development_addons.png rename to src/bonsai/docs/guides/development/ide/images/blender_development_addons.png diff --git a/src/bonsai/docs/quickstart/ide/images/blender_experimental_debugging.png b/src/bonsai/docs/guides/development/ide/images/blender_experimental_debugging.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/blender_experimental_debugging.png rename to src/bonsai/docs/guides/development/ide/images/blender_experimental_debugging.png diff --git a/src/bonsai/docs/quickstart/ide/images/bonsai-doc-server.png b/src/bonsai/docs/guides/development/ide/images/bonsai-doc-server.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/bonsai-doc-server.png rename to src/bonsai/docs/guides/development/ide/images/bonsai-doc-server.png diff --git a/src/bonsai/docs/quickstart/ide/images/bonsai-layout2.png b/src/bonsai/docs/guides/development/ide/images/bonsai-layout2.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/bonsai-layout2.png rename to src/bonsai/docs/guides/development/ide/images/bonsai-layout2.png diff --git a/src/bonsai/docs/quickstart/ide/images/bonsai_debug.png b/src/bonsai/docs/guides/development/ide/images/bonsai_debug.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/bonsai_debug.png rename to src/bonsai/docs/guides/development/ide/images/bonsai_debug.png diff --git a/src/bonsai/docs/quickstart/ide/images/break-point-stop.png b/src/bonsai/docs/guides/development/ide/images/break-point-stop.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/break-point-stop.png rename to src/bonsai/docs/guides/development/ide/images/break-point-stop.png diff --git a/src/bonsai/docs/quickstart/ide/images/break-point.png b/src/bonsai/docs/guides/development/ide/images/break-point.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/break-point.png rename to src/bonsai/docs/guides/development/ide/images/break-point.png diff --git a/src/bonsai/docs/quickstart/ide/images/check-fork.png b/src/bonsai/docs/guides/development/ide/images/check-fork.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/check-fork.png rename to src/bonsai/docs/guides/development/ide/images/check-fork.png diff --git a/src/bonsai/docs/quickstart/ide/images/checkout_pull_request_vscode.png b/src/bonsai/docs/guides/development/ide/images/checkout_pull_request_vscode.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/checkout_pull_request_vscode.png rename to src/bonsai/docs/guides/development/ide/images/checkout_pull_request_vscode.png diff --git a/src/bonsai/docs/quickstart/ide/images/cloned-repo.png b/src/bonsai/docs/guides/development/ide/images/cloned-repo.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/cloned-repo.png rename to src/bonsai/docs/guides/development/ide/images/cloned-repo.png diff --git a/src/bonsai/docs/quickstart/ide/images/cloning-from-github.png b/src/bonsai/docs/guides/development/ide/images/cloning-from-github.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/cloning-from-github.png rename to src/bonsai/docs/guides/development/ide/images/cloning-from-github.png diff --git a/src/bonsai/docs/quickstart/ide/images/commit-changes-linux.png b/src/bonsai/docs/guides/development/ide/images/commit-changes-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/commit-changes-linux.png rename to src/bonsai/docs/guides/development/ide/images/commit-changes-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/commit-changes-windows.png b/src/bonsai/docs/guides/development/ide/images/commit-changes-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/commit-changes-windows.png rename to src/bonsai/docs/guides/development/ide/images/commit-changes-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/compare-and-pull-request.png b/src/bonsai/docs/guides/development/ide/images/compare-and-pull-request.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/compare-and-pull-request.png rename to src/bonsai/docs/guides/development/ide/images/compare-and-pull-request.png diff --git a/src/bonsai/docs/quickstart/ide/images/create-branch.png b/src/bonsai/docs/guides/development/ide/images/create-branch.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/create-branch.png rename to src/bonsai/docs/guides/development/ide/images/create-branch.png diff --git a/src/bonsai/docs/quickstart/ide/images/create-user.png b/src/bonsai/docs/guides/development/ide/images/create-user.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/create-user.png rename to src/bonsai/docs/guides/development/ide/images/create-user.png diff --git a/src/bonsai/docs/quickstart/ide/images/dev-environment-sh-executed.png b/src/bonsai/docs/guides/development/ide/images/dev-environment-sh-executed.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/dev-environment-sh-executed.png rename to src/bonsai/docs/guides/development/ide/images/dev-environment-sh-executed.png diff --git a/src/bonsai/docs/quickstart/ide/images/dev-environment-sh.png b/src/bonsai/docs/guides/development/ide/images/dev-environment-sh.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/dev-environment-sh.png rename to src/bonsai/docs/guides/development/ide/images/dev-environment-sh.png diff --git a/src/bonsai/docs/quickstart/ide/images/doc-pip-furo.png b/src/bonsai/docs/guides/development/ide/images/doc-pip-furo.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/doc-pip-furo.png rename to src/bonsai/docs/guides/development/ide/images/doc-pip-furo.png diff --git a/src/bonsai/docs/quickstart/ide/images/doc-server-running.png b/src/bonsai/docs/guides/development/ide/images/doc-server-running.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/doc-server-running.png rename to src/bonsai/docs/guides/development/ide/images/doc-server-running.png diff --git a/src/bonsai/docs/quickstart/ide/images/edit_source.png b/src/bonsai/docs/guides/development/ide/images/edit_source.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/edit_source.png rename to src/bonsai/docs/guides/development/ide/images/edit_source.png diff --git a/src/bonsai/docs/quickstart/ide/images/enable-developer-extras.png b/src/bonsai/docs/guides/development/ide/images/enable-developer-extras.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/enable-developer-extras.png rename to src/bonsai/docs/guides/development/ide/images/enable-developer-extras.png diff --git a/src/bonsai/docs/quickstart/ide/images/environment-variables.png b/src/bonsai/docs/guides/development/ide/images/environment-variables.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/environment-variables.png rename to src/bonsai/docs/guides/development/ide/images/environment-variables.png diff --git a/src/bonsai/docs/quickstart/ide/images/fork-bonsai.png b/src/bonsai/docs/guides/development/ide/images/fork-bonsai.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/fork-bonsai.png rename to src/bonsai/docs/guides/development/ide/images/fork-bonsai.png diff --git a/src/bonsai/docs/quickstart/ide/images/forked-bonsai.png b/src/bonsai/docs/guides/development/ide/images/forked-bonsai.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/forked-bonsai.png rename to src/bonsai/docs/guides/development/ide/images/forked-bonsai.png diff --git a/src/bonsai/docs/quickstart/ide/images/git-user-email-linux.png b/src/bonsai/docs/guides/development/ide/images/git-user-email-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/git-user-email-linux.png rename to src/bonsai/docs/guides/development/ide/images/git-user-email-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/git-user-email-windows.png b/src/bonsai/docs/guides/development/ide/images/git-user-email-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/git-user-email-windows.png rename to src/bonsai/docs/guides/development/ide/images/git-user-email-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/inkscape-annotation-template.png b/src/bonsai/docs/guides/development/ide/images/inkscape-annotation-template.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/inkscape-annotation-template.png rename to src/bonsai/docs/guides/development/ide/images/inkscape-annotation-template.png diff --git a/src/bonsai/docs/quickstart/ide/images/inkscape-scaling-outline.png b/src/bonsai/docs/guides/development/ide/images/inkscape-scaling-outline.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/inkscape-scaling-outline.png rename to src/bonsai/docs/guides/development/ide/images/inkscape-scaling-outline.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-bpy-fake-linux.png b/src/bonsai/docs/guides/development/ide/images/install-bpy-fake-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-bpy-fake-linux.png rename to src/bonsai/docs/guides/development/ide/images/install-bpy-fake-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-bpy-fake-windows.png b/src/bonsai/docs/guides/development/ide/images/install-bpy-fake-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-bpy-fake-windows.png rename to src/bonsai/docs/guides/development/ide/images/install-bpy-fake-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-python-1.png b/src/bonsai/docs/guides/development/ide/images/install-python-1.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-python-1.png rename to src/bonsai/docs/guides/development/ide/images/install-python-1.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-python-2.png b/src/bonsai/docs/guides/development/ide/images/install-python-2.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-python-2.png rename to src/bonsai/docs/guides/development/ide/images/install-python-2.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-python-3.png b/src/bonsai/docs/guides/development/ide/images/install-python-3.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-python-3.png rename to src/bonsai/docs/guides/development/ide/images/install-python-3.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-python-4.png b/src/bonsai/docs/guides/development/ide/images/install-python-4.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-python-4.png rename to src/bonsai/docs/guides/development/ide/images/install-python-4.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-python-5.png b/src/bonsai/docs/guides/development/ide/images/install-python-5.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-python-5.png rename to src/bonsai/docs/guides/development/ide/images/install-python-5.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-python-6.png b/src/bonsai/docs/guides/development/ide/images/install-python-6.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-python-6.png rename to src/bonsai/docs/guides/development/ide/images/install-python-6.png diff --git a/src/bonsai/docs/quickstart/ide/images/install-vscode.png b/src/bonsai/docs/guides/development/ide/images/install-vscode.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/install-vscode.png rename to src/bonsai/docs/guides/development/ide/images/install-vscode.png diff --git a/src/bonsai/docs/quickstart/ide/images/just-my-code-false.png b/src/bonsai/docs/guides/development/ide/images/just-my-code-false.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/just-my-code-false.png rename to src/bonsai/docs/guides/development/ide/images/just-my-code-false.png diff --git a/src/bonsai/docs/quickstart/ide/images/launch-linux-jason.png b/src/bonsai/docs/guides/development/ide/images/launch-linux-jason.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/launch-linux-jason.png rename to src/bonsai/docs/guides/development/ide/images/launch-linux-jason.png diff --git a/src/bonsai/docs/quickstart/ide/images/launch-terminal.png b/src/bonsai/docs/guides/development/ide/images/launch-terminal.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/launch-terminal.png rename to src/bonsai/docs/guides/development/ide/images/launch-terminal.png diff --git a/src/bonsai/docs/quickstart/ide/images/launch-windows-jason.png b/src/bonsai/docs/guides/development/ide/images/launch-windows-jason.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/launch-windows-jason.png rename to src/bonsai/docs/guides/development/ide/images/launch-windows-jason.png diff --git a/src/bonsai/docs/quickstart/ide/images/make-changes-linux.png b/src/bonsai/docs/guides/development/ide/images/make-changes-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/make-changes-linux.png rename to src/bonsai/docs/guides/development/ide/images/make-changes-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/make-changes-windows.png b/src/bonsai/docs/guides/development/ide/images/make-changes-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/make-changes-windows.png rename to src/bonsai/docs/guides/development/ide/images/make-changes-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/marked_code.png b/src/bonsai/docs/guides/development/ide/images/marked_code.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/marked_code.png rename to src/bonsai/docs/guides/development/ide/images/marked_code.png diff --git a/src/bonsai/docs/quickstart/ide/images/new-branch-in-private-github.png b/src/bonsai/docs/guides/development/ide/images/new-branch-in-private-github.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/new-branch-in-private-github.png rename to src/bonsai/docs/guides/development/ide/images/new-branch-in-private-github.png diff --git a/src/bonsai/docs/quickstart/ide/images/new-branch-local.png b/src/bonsai/docs/guides/development/ide/images/new-branch-local.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/new-branch-local.png rename to src/bonsai/docs/guides/development/ide/images/new-branch-local.png diff --git a/src/bonsai/docs/quickstart/ide/images/new-branch-publish-to-private-github.png b/src/bonsai/docs/guides/development/ide/images/new-branch-publish-to-private-github.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/new-branch-publish-to-private-github.png rename to src/bonsai/docs/guides/development/ide/images/new-branch-publish-to-private-github.png diff --git a/src/bonsai/docs/quickstart/ide/images/print-to-console.png b/src/bonsai/docs/guides/development/ide/images/print-to-console.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/print-to-console.png rename to src/bonsai/docs/guides/development/ide/images/print-to-console.png diff --git a/src/bonsai/docs/quickstart/ide/images/private-fork-new-branch-updated-linux.png b/src/bonsai/docs/guides/development/ide/images/private-fork-new-branch-updated-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/private-fork-new-branch-updated-linux.png rename to src/bonsai/docs/guides/development/ide/images/private-fork-new-branch-updated-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/private-fork-new-branch-updated-windows.png b/src/bonsai/docs/guides/development/ide/images/private-fork-new-branch-updated-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/private-fork-new-branch-updated-windows.png rename to src/bonsai/docs/guides/development/ide/images/private-fork-new-branch-updated-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/pull-changes.png b/src/bonsai/docs/guides/development/ide/images/pull-changes.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/pull-changes.png rename to src/bonsai/docs/guides/development/ide/images/pull-changes.png diff --git a/src/bonsai/docs/quickstart/ide/images/pull-request-linux.png b/src/bonsai/docs/guides/development/ide/images/pull-request-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/pull-request-linux.png rename to src/bonsai/docs/guides/development/ide/images/pull-request-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/pull-request-windows.png b/src/bonsai/docs/guides/development/ide/images/pull-request-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/pull-request-windows.png rename to src/bonsai/docs/guides/development/ide/images/pull-request-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/pull_request_see.png b/src/bonsai/docs/guides/development/ide/images/pull_request_see.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/pull_request_see.png rename to src/bonsai/docs/guides/development/ide/images/pull_request_see.png diff --git a/src/bonsai/docs/quickstart/ide/images/push-to-private-fork-new-branch.png b/src/bonsai/docs/guides/development/ide/images/push-to-private-fork-new-branch.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/push-to-private-fork-new-branch.png rename to src/bonsai/docs/guides/development/ide/images/push-to-private-fork-new-branch.png diff --git a/src/bonsai/docs/quickstart/ide/images/python-downloads.png b/src/bonsai/docs/guides/development/ide/images/python-downloads.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/python-downloads.png rename to src/bonsai/docs/guides/development/ide/images/python-downloads.png diff --git a/src/bonsai/docs/quickstart/ide/images/python-version.png b/src/bonsai/docs/guides/development/ide/images/python-version.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/python-version.png rename to src/bonsai/docs/guides/development/ide/images/python-version.png diff --git a/src/bonsai/docs/quickstart/ide/images/rebase_branch.png b/src/bonsai/docs/guides/development/ide/images/rebase_branch.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/rebase_branch.png rename to src/bonsai/docs/guides/development/ide/images/rebase_branch.png diff --git a/src/bonsai/docs/quickstart/ide/images/restart-blender.png b/src/bonsai/docs/guides/development/ide/images/restart-blender.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/restart-blender.png rename to src/bonsai/docs/guides/development/ide/images/restart-blender.png diff --git a/src/bonsai/docs/quickstart/ide/images/run-as-administrator.png b/src/bonsai/docs/guides/development/ide/images/run-as-administrator.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/run-as-administrator.png rename to src/bonsai/docs/guides/development/ide/images/run-as-administrator.png diff --git a/src/bonsai/docs/quickstart/ide/images/running-dev_environment-bat.png b/src/bonsai/docs/guides/development/ide/images/running-dev_environment-bat.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/running-dev_environment-bat.png rename to src/bonsai/docs/guides/development/ide/images/running-dev_environment-bat.png diff --git a/src/bonsai/docs/quickstart/ide/images/script-blender-vscode-2.png b/src/bonsai/docs/guides/development/ide/images/script-blender-vscode-2.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/script-blender-vscode-2.png rename to src/bonsai/docs/guides/development/ide/images/script-blender-vscode-2.png diff --git a/src/bonsai/docs/quickstart/ide/images/script-blender-vscode.png b/src/bonsai/docs/guides/development/ide/images/script-blender-vscode.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/script-blender-vscode.png rename to src/bonsai/docs/guides/development/ide/images/script-blender-vscode.png diff --git a/src/bonsai/docs/quickstart/ide/images/scripting_ui_code.png b/src/bonsai/docs/guides/development/ide/images/scripting_ui_code.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/scripting_ui_code.png rename to src/bonsai/docs/guides/development/ide/images/scripting_ui_code.png diff --git a/src/bonsai/docs/quickstart/ide/images/selecting-forked-repo.png b/src/bonsai/docs/guides/development/ide/images/selecting-forked-repo.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/selecting-forked-repo.png rename to src/bonsai/docs/guides/development/ide/images/selecting-forked-repo.png diff --git a/src/bonsai/docs/quickstart/ide/images/staging-prior-commit.png b/src/bonsai/docs/guides/development/ide/images/staging-prior-commit.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/staging-prior-commit.png rename to src/bonsai/docs/guides/development/ide/images/staging-prior-commit.png diff --git a/src/bonsai/docs/quickstart/ide/images/step-over-linux.png b/src/bonsai/docs/guides/development/ide/images/step-over-linux.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/step-over-linux.png rename to src/bonsai/docs/guides/development/ide/images/step-over-linux.png diff --git a/src/bonsai/docs/quickstart/ide/images/step-over.png b/src/bonsai/docs/guides/development/ide/images/step-over.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/step-over.png rename to src/bonsai/docs/guides/development/ide/images/step-over.png diff --git a/src/bonsai/docs/quickstart/ide/images/sync-fork.png b/src/bonsai/docs/guides/development/ide/images/sync-fork.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/sync-fork.png rename to src/bonsai/docs/guides/development/ide/images/sync-fork.png diff --git a/src/bonsai/docs/quickstart/ide/images/tasks-linux-jason.png b/src/bonsai/docs/guides/development/ide/images/tasks-linux-jason.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/tasks-linux-jason.png rename to src/bonsai/docs/guides/development/ide/images/tasks-linux-jason.png diff --git a/src/bonsai/docs/quickstart/ide/images/tasks-windows-jason.png b/src/bonsai/docs/guides/development/ide/images/tasks-windows-jason.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/tasks-windows-jason.png rename to src/bonsai/docs/guides/development/ide/images/tasks-windows-jason.png diff --git a/src/bonsai/docs/quickstart/ide/images/terminal-integrated-windows.png b/src/bonsai/docs/guides/development/ide/images/terminal-integrated-windows.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/terminal-integrated-windows.png rename to src/bonsai/docs/guides/development/ide/images/terminal-integrated-windows.png diff --git a/src/bonsai/docs/quickstart/ide/images/trigger-breakpoint.png b/src/bonsai/docs/guides/development/ide/images/trigger-breakpoint.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/trigger-breakpoint.png rename to src/bonsai/docs/guides/development/ide/images/trigger-breakpoint.png diff --git a/src/bonsai/docs/quickstart/ide/images/vscode_search_in_files.png b/src/bonsai/docs/guides/development/ide/images/vscode_search_in_files.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/vscode_search_in_files.png rename to src/bonsai/docs/guides/development/ide/images/vscode_search_in_files.png diff --git a/src/bonsai/docs/quickstart/ide/images/vscode_search_results.png b/src/bonsai/docs/guides/development/ide/images/vscode_search_results.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/vscode_search_results.png rename to src/bonsai/docs/guides/development/ide/images/vscode_search_results.png diff --git a/src/bonsai/docs/quickstart/ide/images/win-add-user.png b/src/bonsai/docs/guides/development/ide/images/win-add-user.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/win-add-user.png rename to src/bonsai/docs/guides/development/ide/images/win-add-user.png diff --git a/src/bonsai/docs/quickstart/ide/images/windows-path.png b/src/bonsai/docs/guides/development/ide/images/windows-path.png similarity index 100% rename from src/bonsai/docs/quickstart/ide/images/windows-path.png rename to src/bonsai/docs/guides/development/ide/images/windows-path.png diff --git a/src/bonsai/docs/quickstart/ide/index.rst b/src/bonsai/docs/guides/development/ide/index.rst similarity index 91% rename from src/bonsai/docs/quickstart/ide/index.rst rename to src/bonsai/docs/guides/development/ide/index.rst index 4e279cba8f..afa7cab67f 100644 --- a/src/bonsai/docs/quickstart/ide/index.rst +++ b/src/bonsai/docs/guides/development/ide/index.rst @@ -1,5 +1,5 @@ Exploring Bonsai Sourcecode -=========== +=========================== Here are quickstarts to help contribute to Bonsai either by troubleshooting or proposing new features for either the srouce code or the documentation. diff --git a/src/bonsai/docs/quickstart/ide/linux/dev_environment.sh b/src/bonsai/docs/guides/development/ide/linux/dev_environment.sh similarity index 100% rename from src/bonsai/docs/quickstart/ide/linux/dev_environment.sh rename to src/bonsai/docs/guides/development/ide/linux/dev_environment.sh diff --git a/src/bonsai/docs/quickstart/ide/linux/launch.json b/src/bonsai/docs/guides/development/ide/linux/launch.json similarity index 100% rename from src/bonsai/docs/quickstart/ide/linux/launch.json rename to src/bonsai/docs/guides/development/ide/linux/launch.json diff --git a/src/bonsai/docs/quickstart/ide/linux/tasks.json b/src/bonsai/docs/guides/development/ide/linux/tasks.json similarity index 100% rename from src/bonsai/docs/quickstart/ide/linux/tasks.json rename to src/bonsai/docs/guides/development/ide/linux/tasks.json diff --git a/src/bonsai/docs/quickstart/ide/linux_ide.rst b/src/bonsai/docs/guides/development/ide/linux_ide.rst similarity index 100% rename from src/bonsai/docs/quickstart/ide/linux_ide.rst rename to src/bonsai/docs/guides/development/ide/linux_ide.rst diff --git a/src/bonsai/docs/quickstart/ide/macos_ide.rst b/src/bonsai/docs/guides/development/ide/macos_ide.rst similarity index 80% rename from src/bonsai/docs/quickstart/ide/macos_ide.rst rename to src/bonsai/docs/guides/development/ide/macos_ide.rst index 446bf898a1..306ceb70e1 100644 --- a/src/bonsai/docs/quickstart/ide/macos_ide.rst +++ b/src/bonsai/docs/guides/development/ide/macos_ide.rst @@ -5,4 +5,4 @@ This quickstart will help you set up your MacOS machine to explore the sourcecod You will be able to update or contribute to the official documentation and also explore the code behind Bonsai's functionalities to troubleshoot or propose new features for Bonsai. -Please be patient while this documentation is created. Meanwhile you can check the :doc:`/quickstart/ide/linux_ide` guide which should be fairly similar. \ No newline at end of file +Please be patient while this documentation is created. Meanwhile you can check the :doc:`linux_ide` guide which should be fairly similar. \ No newline at end of file diff --git a/src/bonsai/docs/quickstart/ide/windows/dev_environment.bat b/src/bonsai/docs/guides/development/ide/windows/dev_environment.bat similarity index 100% rename from src/bonsai/docs/quickstart/ide/windows/dev_environment.bat rename to src/bonsai/docs/guides/development/ide/windows/dev_environment.bat diff --git a/src/bonsai/docs/quickstart/ide/windows/launch.json b/src/bonsai/docs/guides/development/ide/windows/launch.json similarity index 100% rename from src/bonsai/docs/quickstart/ide/windows/launch.json rename to src/bonsai/docs/guides/development/ide/windows/launch.json diff --git a/src/bonsai/docs/quickstart/ide/windows/tasks.json b/src/bonsai/docs/guides/development/ide/windows/tasks.json similarity index 100% rename from src/bonsai/docs/quickstart/ide/windows/tasks.json rename to src/bonsai/docs/guides/development/ide/windows/tasks.json diff --git a/src/bonsai/docs/quickstart/ide/windows_ide.rst b/src/bonsai/docs/guides/development/ide/windows_ide.rst similarity index 100% rename from src/bonsai/docs/quickstart/ide/windows_ide.rst rename to src/bonsai/docs/guides/development/ide/windows_ide.rst diff --git a/src/bonsai/docs/guides/development/index.rst b/src/bonsai/docs/guides/development/index.rst index 009fc835be..8852892361 100644 --- a/src/bonsai/docs/guides/development/index.rst +++ b/src/bonsai/docs/guides/development/index.rst @@ -9,10 +9,14 @@ This chapter covers how you can help contribute to Bonsai. :hidden: :maxdepth: 2 + getting_started installation hello_world + code_style running_tests + ux_guidelines translations undo_system writing_docs debugging + ide/index diff --git a/src/bonsai/docs/guides/development/writing_docs.rst b/src/bonsai/docs/guides/development/writing_docs.rst index 1aaccea69a..cc17177796 100644 --- a/src/bonsai/docs/guides/development/writing_docs.rst +++ b/src/bonsai/docs/guides/development/writing_docs.rst @@ -158,6 +158,14 @@ Or ordered lists: Tables can be very annoying to format. You can use a CSV table instead. +.. code-block:: restructuredtext + + .. include:: /_incomplete_message.rst + +Will automatically add this banner to the top of the page: + +.. include:: /_incomplete_message.rst + .. csv-table:: :header: "Foo", "Bar", "Baz" @@ -186,8 +194,6 @@ Now you can generate the documentation: cd _build/html python -m http.server -.. warning:: - .. warning:: Depending on your machine and environment, you might need to use ``.\make`` instead of ``make``. @@ -200,7 +206,7 @@ will return something like seen underneath, replace [::] with localhost. Serving HTTP on :: port 8000 (http://[::]:8000/) ... Streamlining your workflow -^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^ Now that you have added or changed some content in the documentation, you may want to see it on the webserver. Initially you can: diff --git a/src/bonsai/docs/guides/drawings/index.rst b/src/bonsai/docs/guides/drawings/index.rst index 15e0f79b1e..d6c524ee23 100644 --- a/src/bonsai/docs/guides/drawings/index.rst +++ b/src/bonsai/docs/guides/drawings/index.rst @@ -1,7 +1,7 @@ ====================== Drawings and documents ====================== - +.. include:: /_incomplete_message.rst Bonsai provides powerful tools for generating 2D drawings from your 3D BIM models and adding detailed annotations. This section covers the process of creating various types of drawings and enhancing them with annotations. diff --git a/src/bonsai/docs/guides/facility_management/index.rst b/src/bonsai/docs/guides/facility_management/index.rst index 7db982a682..f3a8922a0b 100644 --- a/src/bonsai/docs/guides/facility_management/index.rst +++ b/src/bonsai/docs/guides/facility_management/index.rst @@ -1,4 +1,3 @@ Facility management =================== - -TODO +.. include:: /_incomplete_message.rst diff --git a/src/bonsai/docs/guides/services/index.rst b/src/bonsai/docs/guides/services/index.rst index 3bd2da24a2..935c28a453 100644 --- a/src/bonsai/docs/guides/services/index.rst +++ b/src/bonsai/docs/guides/services/index.rst @@ -1,4 +1,3 @@ Services and systems ==================== - -TODO +.. include:: /_incomplete_message.rst \ No newline at end of file diff --git a/src/bonsai/docs/guides/structural_analysis/index.rst b/src/bonsai/docs/guides/structural_analysis/index.rst index cb231a7021..4b65c62b24 100644 --- a/src/bonsai/docs/guides/structural_analysis/index.rst +++ b/src/bonsai/docs/guides/structural_analysis/index.rst @@ -3,8 +3,7 @@ Structural analysis This section covers the structural analysis capabilities in Bonsai. -.. note:: - This page is a stub. More detailed content will be added in future updates. +.. include:: /_incomplete_message.rst Overview -------- @@ -29,5 +28,5 @@ To begin using the structural analysis features in Bonsai: 3. Define load cases and boundary conditions .. seealso:: - - :doc:`/users/modeling/ifc_modeling` - - :doc:`/users/advanced/index` + - :doc:`/guides/authoring/index` + - :doc:`/guides/authoring/advanced_modeling/index` diff --git a/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst b/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst index 3b110b9567..d5a7a8cb42 100644 --- a/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst +++ b/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst @@ -92,7 +92,7 @@ You may filter elements and only load a portion of the model. Click on .. image:: images/advanced-mode.png This will preload the model and present you with model loading options in the -:doc:`Project Info ` +:doc:`Project Info ` panel. .. image:: images/advanced-mode-settings.png diff --git a/src/bonsai/docs/guides/viewing/index.rst b/src/bonsai/docs/guides/viewing/index.rst index a505f6cc13..558d3dad13 100644 --- a/src/bonsai/docs/guides/viewing/index.rst +++ b/src/bonsai/docs/guides/viewing/index.rst @@ -1,6 +1,6 @@ Viewing models ============== - +.. include:: /_incomplete_message.rst This chapter covers how to navigate and explore models. .. container:: global-index-toc diff --git a/src/bonsai/docs/index.rst b/src/bonsai/docs/index.rst index 0e4d91d664..a8bc246d1b 100644 --- a/src/bonsai/docs/index.rst +++ b/src/bonsai/docs/index.rst @@ -45,32 +45,42 @@ and data-rich OpenBIM with Blender :) quickstart/installation quickstart/explore_model quickstart/create_model - quickstart/ide/index quickstart/next_steps .. toctree:: :hidden: :caption: Guides - :maxdepth: 2 + :maxdepth: 3 - guides/viewing/dealing_with_large_models - guides/authoring/georeferencing - guides/authoring/git_support - guides/development/index - guides/alignment - guides/authoring/other_addons + guides/authoring/index + guides/viewing/index + guides/coordination/index + guides/costing_and_scheduling/index + guides/drawings/index + guides/facility_management/index + guides/services/index + guides/structural_analysis/index guides/troubleshooting - guides/debugging - + guides/alignment + guides/development/index + tutorials/index .. toctree:: :hidden: :caption: Reference :maxdepth: 2 - reference/interface - reference/topbar - reference/properties - reference/hotkeys + reference/general/index + reference/toolbar/index + reference/costing_and_scheduling/index + reference/drawings_and_documents/index + reference/facility_management/index + reference/geometry_and_materials/index + reference/object_information/index + reference/project_overview/index + reference/quality_and_coordination/index + reference/services_and_systems/index + reference/structural_analysis/index + Need more help? Join the `live chat `__ or `community forums `__. Something strange happening? Please diff --git a/src/bonsai/docs/quickstart/next_steps.rst b/src/bonsai/docs/quickstart/next_steps.rst index 600d56525f..044a90f63f 100644 --- a/src/bonsai/docs/quickstart/next_steps.rst +++ b/src/bonsai/docs/quickstart/next_steps.rst @@ -3,10 +3,10 @@ Next Steps Now that you've completed the quickstart guide, you're ready to dive deeper into Bonsai's capabilities. Here are some suggested next steps to continue your learning journey: -* :doc:`Modeling and Creating IFC Models ` +* :doc:`Modeling and Creating IFC Models ` Explore advanced modeling techniques and learn how to create complex IFC models. -* :doc:`Tutorials and Real-World Projects ` +* :doc:`Tutorials and Real-World Projects ` Apply your skills to practical, real-world BIM projects with our step-by-step tutorials. These resources will help you build upon the foundation you've established and develop more advanced skills in using Bonsai for your architectural and engineering projects. diff --git a/src/bonsai/docs/reference/costing_and_scheduling/index.rst b/src/bonsai/docs/reference/costing_and_scheduling/index.rst index 3890c9e56e..70d5c269b4 100644 --- a/src/bonsai/docs/reference/costing_and_scheduling/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/drawings_and_documents/index.rst b/src/bonsai/docs/reference/drawings_and_documents/index.rst index b0de4afc84..3ef3a216be 100644 --- a/src/bonsai/docs/reference/drawings_and_documents/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/facility_management/index.rst b/src/bonsai/docs/reference/facility_management/index.rst index 7fef312878..2dae7ee9e7 100644 --- a/src/bonsai/docs/reference/facility_management/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/general/3d_viewport.rst b/src/bonsai/docs/reference/general/3d_viewport.rst new file mode 100644 index 0000000000..f32717f969 --- /dev/null +++ b/src/bonsai/docs/reference/general/3d_viewport.rst @@ -0,0 +1,3 @@ +3D Viewport +=========== +.. include:: /_incomplete_message.rst \ No newline at end of file diff --git a/src/bonsai/docs/reference/blender.rst b/src/bonsai/docs/reference/general/blender.rst similarity index 89% rename from src/bonsai/docs/reference/blender.rst rename to src/bonsai/docs/reference/general/blender.rst index 3cb376e87b..6c26eaa578 100644 --- a/src/bonsai/docs/reference/blender.rst +++ b/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 diff --git a/src/bonsai/docs/reference/hotkeys.rst b/src/bonsai/docs/reference/general/hotkeys.rst similarity index 96% rename from src/bonsai/docs/reference/hotkeys.rst rename to src/bonsai/docs/reference/general/hotkeys.rst index a8e0f770ac..c52a2bac13 100644 --- a/src/bonsai/docs/reference/hotkeys.rst +++ b/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) diff --git a/src/bonsai/docs/reference/images/interface-panel.png b/src/bonsai/docs/reference/general/images/interface-panel.png similarity index 100% rename from src/bonsai/docs/reference/images/interface-panel.png rename to src/bonsai/docs/reference/general/images/interface-panel.png diff --git a/src/bonsai/docs/reference/images/interface-split-merge.png b/src/bonsai/docs/reference/general/images/interface-split-merge.png similarity index 100% rename from src/bonsai/docs/reference/images/interface-split-merge.png rename to src/bonsai/docs/reference/general/images/interface-split-merge.png diff --git a/src/bonsai/docs/reference/images/interface-tabs.png b/src/bonsai/docs/reference/general/images/interface-tabs.png similarity index 100% rename from src/bonsai/docs/reference/images/interface-tabs.png rename to src/bonsai/docs/reference/general/images/interface-tabs.png diff --git a/src/bonsai/docs/reference/images/interface.png b/src/bonsai/docs/reference/general/images/interface.png similarity index 100% rename from src/bonsai/docs/reference/images/interface.png rename to src/bonsai/docs/reference/general/images/interface.png diff --git a/src/bonsai/docs/reference/images/properties-tabs.png b/src/bonsai/docs/reference/general/images/properties-tabs.png similarity index 100% rename from src/bonsai/docs/reference/images/properties-tabs.png rename to src/bonsai/docs/reference/general/images/properties-tabs.png diff --git a/src/bonsai/docs/reference/images/topbar-file-import.png b/src/bonsai/docs/reference/general/images/topbar-file-import.png similarity index 100% rename from src/bonsai/docs/reference/images/topbar-file-import.png rename to src/bonsai/docs/reference/general/images/topbar-file-import.png diff --git a/src/bonsai/docs/reference/images/topbar-file-new.png b/src/bonsai/docs/reference/general/images/topbar-file-new.png similarity index 100% rename from src/bonsai/docs/reference/images/topbar-file-new.png rename to src/bonsai/docs/reference/general/images/topbar-file-new.png diff --git a/src/bonsai/docs/reference/images/topbar-file-recent.png b/src/bonsai/docs/reference/general/images/topbar-file-recent.png similarity index 100% rename from src/bonsai/docs/reference/images/topbar-file-recent.png rename to src/bonsai/docs/reference/general/images/topbar-file-recent.png diff --git a/src/bonsai/docs/reference/images/topbar-file.png b/src/bonsai/docs/reference/general/images/topbar-file.png similarity index 100% rename from src/bonsai/docs/reference/images/topbar-file.png rename to src/bonsai/docs/reference/general/images/topbar-file.png diff --git a/src/bonsai/docs/reference/general/index.rst b/src/bonsai/docs/reference/general/index.rst new file mode 100644 index 0000000000..1c4411a497 --- /dev/null +++ b/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 diff --git a/src/bonsai/docs/reference/general/interface.rst b/src/bonsai/docs/reference/general/interface.rst new file mode 100644 index 0000000000..f30e4adaee --- /dev/null +++ b/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 ` - 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 ` - 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 ` - shows properties about your project, non-geometric objects, and selected objects from the 3D view. +5. :doc:`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 ` 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 + `__. diff --git a/src/bonsai/docs/reference/general/outliner.rst b/src/bonsai/docs/reference/general/outliner.rst new file mode 100644 index 0000000000..70cf35240c --- /dev/null +++ b/src/bonsai/docs/reference/general/outliner.rst @@ -0,0 +1,4 @@ +Outliner +======== + +.. include:: /_incomplete_message.rst \ No newline at end of file diff --git a/src/bonsai/docs/reference/properties.rst b/src/bonsai/docs/reference/general/properties.rst similarity index 100% rename from src/bonsai/docs/reference/properties.rst rename to src/bonsai/docs/reference/general/properties.rst diff --git a/src/bonsai/docs/reference/scene.rst b/src/bonsai/docs/reference/general/scene.rst similarity index 100% rename from src/bonsai/docs/reference/scene.rst rename to src/bonsai/docs/reference/general/scene.rst diff --git a/src/bonsai/docs/reference/general/status_bar.rst b/src/bonsai/docs/reference/general/status_bar.rst new file mode 100644 index 0000000000..c01a205e3a --- /dev/null +++ b/src/bonsai/docs/reference/general/status_bar.rst @@ -0,0 +1,3 @@ +Status Bar +========== +.. include:: /_incomplete_message.rst \ No newline at end of file diff --git a/src/bonsai/docs/reference/switch_tab.rst b/src/bonsai/docs/reference/general/switch_tab.rst similarity index 74% rename from src/bonsai/docs/reference/switch_tab.rst rename to src/bonsai/docs/reference/general/switch_tab.rst index 7724c97b7a..3cb8a2d232 100644 --- a/src/bonsai/docs/reference/switch_tab.rst +++ b/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 diff --git a/src/bonsai/docs/reference/topbar.rst b/src/bonsai/docs/reference/general/topbar.rst similarity index 78% rename from src/bonsai/docs/reference/topbar.rst rename to src/bonsai/docs/reference/general/topbar.rst index 8744e55809..16088e6eac 100644 --- a/src/bonsai/docs/reference/topbar.rst +++ b/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 `__. @@ -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 diff --git a/src/bonsai/docs/reference/interface.rst b/src/bonsai/docs/reference/interface.rst deleted file mode 100644 index 01c21bdb3d..0000000000 --- a/src/bonsai/docs/reference/interface.rst +++ /dev/null @@ -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 ` - 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 ` - 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 ` - shows a 3D view of your geometric objects. -4. :doc:`Properties Panel ` - shows properties about your project, non-geometric objects, and selected objects from the 3D view. -5. :doc:`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 ` 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 - `__. diff --git a/src/bonsai/docs/reference/object_information/index.rst b/src/bonsai/docs/reference/object_information/index.rst index 5d04302b30..f4df459479 100644 --- a/src/bonsai/docs/reference/object_information/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/project_overview/index.rst b/src/bonsai/docs/reference/project_overview/index.rst index 0e1aed6797..a2c5737756 100644 --- a/src/bonsai/docs/reference/project_overview/index.rst +++ b/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. diff --git a/src/bonsai/docs/reference/project_overview/project_info.rst b/src/bonsai/docs/reference/project_overview/project_info.rst index 0911d1f27a..f2fe105f8c 100644 --- a/src/bonsai/docs/reference/project_overview/project_info.rst +++ b/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. diff --git a/src/bonsai/docs/reference/quality_and_coordination/index.rst b/src/bonsai/docs/reference/quality_and_coordination/index.rst index 5f5dfa5e14..4fc9da480d 100644 --- a/src/bonsai/docs/reference/quality_and_coordination/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/services_and_systems/index.rst b/src/bonsai/docs/reference/services_and_systems/index.rst index 297524aac0..1d4ed05e26 100644 --- a/src/bonsai/docs/reference/services_and_systems/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/structural_analysis/index.rst b/src/bonsai/docs/reference/structural_analysis/index.rst index aea0631c8b..b666b6a45b 100644 --- a/src/bonsai/docs/reference/structural_analysis/index.rst +++ b/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 diff --git a/src/bonsai/docs/reference/toolbar/annotation.rst b/src/bonsai/docs/reference/toolbar/annotation.rst index 630b979bdf..938e26858d 100644 --- a/src/bonsai/docs/reference/toolbar/annotation.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/beam.rst b/src/bonsai/docs/reference/toolbar/beam.rst index d33b70f48d..643f5e03c4 100644 --- a/src/bonsai/docs/reference/toolbar/beam.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/column.rst b/src/bonsai/docs/reference/toolbar/column.rst index 2ae62077c1..2a0de558a8 100644 --- a/src/bonsai/docs/reference/toolbar/column.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/covering.rst b/src/bonsai/docs/reference/toolbar/covering.rst index 0ce264523e..875781e879 100644 --- a/src/bonsai/docs/reference/toolbar/covering.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/door.rst b/src/bonsai/docs/reference/toolbar/door.rst index 6fb67f6ee9..ee59920c5b 100644 --- a/src/bonsai/docs/reference/toolbar/door.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/duct.rst b/src/bonsai/docs/reference/toolbar/duct.rst index ed1e773ee5..5081e5dfdb 100644 --- a/src/bonsai/docs/reference/toolbar/duct.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/element.rst b/src/bonsai/docs/reference/toolbar/element.rst index 8a2d11ebc4..24c1383ebe 100644 --- a/src/bonsai/docs/reference/toolbar/element.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/slab.rst b/src/bonsai/docs/reference/toolbar/slab.rst index ca7882d3f2..6df59fce69 100644 --- a/src/bonsai/docs/reference/toolbar/slab.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/spatial.rst b/src/bonsai/docs/reference/toolbar/spatial.rst index 8469923092..85c79d8c32 100644 --- a/src/bonsai/docs/reference/toolbar/spatial.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/structural.rst b/src/bonsai/docs/reference/toolbar/structural.rst index 9e4da36a28..0d0473b869 100644 --- a/src/bonsai/docs/reference/toolbar/structural.rst +++ b/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. diff --git a/src/bonsai/docs/reference/toolbar/window.rst b/src/bonsai/docs/reference/toolbar/window.rst index fdb93d1d2e..fd53443ba8 100644 --- a/src/bonsai/docs/reference/toolbar/window.rst +++ b/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. diff --git a/src/bonsai/docs/tutorials/index.rst b/src/bonsai/docs/tutorials/index.rst new file mode 100644 index 0000000000..d7df5900f0 --- /dev/null +++ b/src/bonsai/docs/tutorials/index.rst @@ -0,0 +1,63 @@ +Tutorials and Real-World Projects +================================= + +This chapter covers multiple real-World Projects + +.. only:: builder_html and (not singlehtml) + + .. container:: toc-cards + + .. container:: card + + :doc:`project0` + In this introductory project, you'll learn the basics of using Bonsai to design a simple room. + By the end of this tutorial, you'll have created a basic 3D model and a 2D floor plan drawing. + + + + .. container:: card + + :doc:`project1` + Building on the skills from Project 0, this tutorial will guide you through designing a complete flat using Bonsai. + You'll learn more advanced techniques for creating walls and openings, working with profiles, defining rooms and spaces, + and generating more detailed drawings. + + + .. container:: card + + :doc:`project2` + In this project, we'll take your Bonsai skills to the next level by designing a complete bungalow. + You'll learn about roof design, advanced foundations, structural elements, and more complex MEP systems. + We'll also introduce basic costing and scheduling concepts. + + .. container:: card + + :doc:`project3` + In this project, we'll design a multi-storey single-family home using Bonsai. + This tutorial will introduce more advanced concepts such as templating, complex roofs, and sophisticated MEP systems. + We'll also touch on basic site landscaping. + + .. container:: card + + :doc:`project4` + In this project, we'll design a row of terraced houses, town houses, or duplexes using Bonsai. + This tutorial will introduce concepts such as shared walls, duplicating units, parametric design, + and collaboration with other stakeholders. + + .. container:: card + + :doc:`project5` + In this final project, we'll design a complex apartment block using Bonsai. + This tutorial will introduce advanced concepts such as multi-level design, vertical transportation, parametric services, + complex structural elements, and advanced project management techniques. + +.. toctree:: + :maxdepth: 1 + + project0 + project1 + project2 + project3 + project4 + project5 + diff --git a/src/bonsai/docs/tutorials/project0.rst b/src/bonsai/docs/tutorials/project0.rst index ced8c9e705..ca4acd4de0 100644 --- a/src/bonsai/docs/tutorials/project0.rst +++ b/src/bonsai/docs/tutorials/project0.rst @@ -37,7 +37,7 @@ Tutorial Steps 3. Save it as `project0.ifc` file. 4. (optional) Save the `project0.blend` file. -.. note:: See :doc:`/users/modeling/starting_new_project` for detailed instructions. +.. note:: See :doc:`/guides/authoring/starting_new_project` for detailed instructions. 2. Creating Walls ----------------- @@ -56,7 +56,7 @@ Tutorial Steps 6. Use a Measure tool to ensure proper dimensions. The interior lenghts of the walls should be 2.8m, 2.7m and 2.6m. -.. note:: Refer to :doc:`/users/modeling/basic_modeling/creating_walls` for step-by-step guidance on wall creation. +.. note:: Refer to :doc:`/guides/authoring/basic_modeling/creating_walls` for step-by-step guidance on wall creation. If you still struggling, here's what you should get: @@ -105,7 +105,7 @@ If you still struggling, here's what you should get: 6. Ensure that the openings do not intersect with corners or other openings. -.. note:: Refer to :doc:`/users/modeling/basic_modeling/openings/index` for detailed instructions +.. note:: Refer to :doc:`/guides/authoring/basic_modeling/opening` for detailed instructions on creating and modifying openings, including how to create openings without fillings. If you're having difficulties, you can download the sample file: diff --git a/src/bonsai/docs/tutorials/project1.rst b/src/bonsai/docs/tutorials/project1.rst index 04b8a92700..73de031128 100644 --- a/src/bonsai/docs/tutorials/project1.rst +++ b/src/bonsai/docs/tutorials/project1.rst @@ -26,13 +26,14 @@ Tutorial Steps 1. Project Setup ---------------- - +.. include:: /_incomplete_message.rst + 1. Open Blender and switch to the Bonsai workspace 2. Create a new IFC project 3. Save it as `project1.ifc` file (and optionally, `project1.blend` file) 4. Load custom libraries and templates -.. note:: See :doc:`/users/modeling/starting_new_project` for detailed instructions. +.. note:: See :doc:`/guides/authoring/starting_new_project` for detailed instructions. 2. Advanced Wall Creation ------------------------- diff --git a/src/bonsai/docs/tutorials/project2.rst b/src/bonsai/docs/tutorials/project2.rst index 5cd5b7f3db..75b61bf6cb 100644 --- a/src/bonsai/docs/tutorials/project2.rst +++ b/src/bonsai/docs/tutorials/project2.rst @@ -2,6 +2,8 @@ Project 2: Building a Bungalow ============================== +.. include:: /_incomplete_message.rst + In this project, we'll take your Bonsai skills to the next level by designing a complete bungalow. You'll learn about roof design, advanced foundations, structural elements, and more complex MEP systems. We'll also introduce basic costing and scheduling concepts. @@ -34,7 +36,7 @@ Tutorial Steps 2. Define project parameters (site conditions, climate zone, etc.) 3. Create a basic site plan -.. note:: See :doc:`/users/modeling/starting_new_project` for detailed instructions. +.. note:: See :doc:`/guides/authoring/starting_new_project` for detailed instructions. 2. Advanced Foundation Design diff --git a/src/bonsai/docs/tutorials/project3.rst b/src/bonsai/docs/tutorials/project3.rst index 78b35fd80f..f76b9d3cdb 100644 --- a/src/bonsai/docs/tutorials/project3.rst +++ b/src/bonsai/docs/tutorials/project3.rst @@ -2,6 +2,8 @@ Project 3: Multi-Storey Single-Family Home ========================================== +.. include:: /_incomplete_message.rst + In this project, we'll design a multi-storey single-family home using Bonsai. This tutorial will introduce more advanced concepts such as templating, complex roofs, and sophisticated MEP systems. We'll also touch on basic site landscaping. diff --git a/src/bonsai/docs/tutorials/project4.rst b/src/bonsai/docs/tutorials/project4.rst index 7a6809d498..addb1933a7 100644 --- a/src/bonsai/docs/tutorials/project4.rst +++ b/src/bonsai/docs/tutorials/project4.rst @@ -2,6 +2,8 @@ Project 4: Terraced/Town Houses/Duplexes ======================================== +.. include:: /_incomplete_message.rst + In this project, we'll design a row of terraced houses, town houses, or duplexes using Bonsai. This tutorial will introduce concepts such as shared walls, duplicating units, parametric design, and collaboration with other stakeholders. diff --git a/src/bonsai/docs/tutorials/project5.rst b/src/bonsai/docs/tutorials/project5.rst index 3ca36e404b..368d5bfe3e 100644 --- a/src/bonsai/docs/tutorials/project5.rst +++ b/src/bonsai/docs/tutorials/project5.rst @@ -9,6 +9,8 @@ complex structural elements, and advanced project management techniques. Prerequisites ============= +.. include:: /_incomplete_message.rst + - Completion of Project 4: Terraced/Town Houses/Duplexes - Expert-level understanding of Bonsai and IFC concepts - Basic knowledge of structural and MEP engineering principles