diff --git a/src/bonsai/docs/_static/custom.css b/src/bonsai/docs/_static/custom.css index 99779b374b..a4493ca3dc 100644 --- a/src/bonsai/docs/_static/custom.css +++ b/src/bonsai/docs/_static/custom.css @@ -65,6 +65,11 @@ section img { font-style: italic; color: var(--color-admonition-text); } +img.transparent { + width: auto; + height: auto; + box-shadow: none; +} img.icon { width: auto; height: auto; diff --git a/src/bonsai/docs/devs/code_style.rst b/src/bonsai/docs/devs/code_style.rst deleted file mode 100644 index 76a9802c22..0000000000 --- a/src/bonsai/docs/devs/code_style.rst +++ /dev/null @@ -1,20 +0,0 @@ -Code style -============ - - -Black code formatter -------------------------------- -For Python code formatting, we use `Black code formatter `__ with ``--line-length 120``. - -``black`` can be installed using ``pip install black`` and files can be formatted with the following example command: - -.. code-block:: bash - - black --line-length 120 src/bonsai/bonsai/bim/module/qto/operator.py - -Using PowerShell, you can run the Black formatter on the last commit in the repository. -You can change ``~1`` to ``~n`` to affect ``n`` commits. - -.. code-block:: powershell - - git diff HEAD HEAD~1 --name-only | where {$_ -like "*.py"} | foreach-object { start $_ && black --line-length 120 $_ } diff --git a/src/bonsai/docs/devs/getting_started.rst b/src/bonsai/docs/devs/getting_started.rst deleted file mode 100644 index a5f7eb12e7..0000000000 --- a/src/bonsai/docs/devs/getting_started.rst +++ /dev/null @@ -1,29 +0,0 @@ -Getting Started -=============== - -Bonsai is an open-source project, and its development is driven by the contributions of a dedicated community of developers, -architects, engineers, and enthusiasts. If you're interested in contributing to the project, whether by submitting bug reports, -suggesting new features, or contributing code, your involvement is highly encouraged and appreciated. - -This part of the documentation covers various aspects of the Bonsai development process, including: - -- :doc:`Writing User Documentation ` -- :doc:`Translations and Internationalisation ` -- Contributing Code - - :doc:`Installation and Setting up a Development Environment ` - - Understanding the Project Structure and Codebase - - :doc:`Hello, World! ` - - :doc:`Undo System ` - - :doc:`Code Style Guidelines and Best Practices ` - -.. - - :doc:`Submitting Pull Requests and Contributing Code ` - -- :doc:`Testing and Quality Assurance ` - - :doc:`Running Tests ` -- :doc:`System Support and Multiplatform Compatibility ` -- :doc:`User Experience and User Interface Guidelines ` - -The Bonsai Developer Documentation is a living resource maintained by the core development team and the open-source community. It serves as a central hub for developers who want to get involved in the project, ensuring a consistent and efficient development process. - -By contributing to Bonsai, you'll not only be helping to improve and expand the capabilities of this powerful open-source BIM authoring platform but also be part of a vibrant community driving innovation in the AEC industry. diff --git a/src/bonsai/docs/devs/ux_guidelines.rst b/src/bonsai/docs/devs/ux_guidelines.rst deleted file mode 100644 index 96e526baf1..0000000000 --- a/src/bonsai/docs/devs/ux_guidelines.rst +++ /dev/null @@ -1,178 +0,0 @@ -User Experience and User Interface guidelines -============================================= - -This is intended as a reference document for developers working on the Bonsai. - -Operators -^^^^^^^^^ - -BIM will by definition contain a (big) number of submodules or subschemas. Granting access to the features of these submodules to the users needs to be considered with several things in minds : - -1. Ease of use : How do I achieve my goal with the minimal number of clicks ? How many different menu items do I have to go through to get to my goal ? How long do I have to scroll a menu to get to the specific thing I have in mind ? - -2. Clarity : How long do I have to visually parse the interface to find the item or button I'm looking for ? Are the buttons correctly labeled and are the icons descriptive enough ? If something is forbidden, can I easily know why ? Can I know what a button does before clicking on it ? - -3. Completeness : I need to have access to all the items that are related to the topic I'm interested in. If it is tied to another submodule, I need to have access to it. - -* **Blender** - - These considerations must be adapted to the Python API, to the general paradigm we have chosen to access, modify or create IFC data, and to the general philosophy of Blender. There are many ways and places where an add-on creator can choose to present information to the user. Bonsai currently works that way : - - - Information about the current context is displayed inside the properties editor. We leverage the fact that it is already built around displaying different types of information whether we are in the Scene, Material, Mesh, Object, Curve, Texture, etc. subpanels. It fits really well with the way things are already organized in the IFC classification. - - - Tools to create, modify or delete items are in the dedicated Toolbar (The left one) in the 3D viewport - - - Some Misc tools and information are displayed in the N panel of the 3D viewport . They're shortcuts to things that are already present elsewhere in the UI, but are handy to have when modifying objects or geometry in the Viewport. - - - Adding specific Import / Export IFC operators (arguably a bit misleading since Bonsai does more than import / export in these operations) - -* **Interface panels** - - - The good : Every submodule is visually separated from each other. The user can customize its interface to only show what's relevant to them at any one point by folding in or out panels. Development / Debugging is facilitated because each submodule's interface is separated from the others. - - - The bad : Having many interface panels clutters the interface, leading to an overwhelming experience for newcomers especially. - - - Proposal : The addon should in the long run provide the user with dynamic UI depending on what's their usecase. Preferably accessed in the Addon Preferences interface, with pre-made options that dynamically enable or disable specific parts of the UI. It should also provide the option to selectively add or remove specific parts of the UI on top of that. Additionally, when it does not make sense to display a specific panel, it should be hidden from the UI. (eg if an object has no IFC Class, it can't be spatially contained, so the IFC Spatial Container panel should be hidden until the user sets the IFC class) - In the long term it could also be interesting to think about some kind of tutorial mode where more information is conveyed through the interface for new users. - -* **Item Lists** - - An item list should provide right off the bat a few features : - - - Add a new item. - - - Modify an item, whether by adding a button to each item in the list, or adding a button on the list header to modify the selected item. - - - Delete an item, whether by adding a button to each item in the list, or adding a button on the list header to delete the selected item. - - - Modify an item's name by double-clicking on the field if applicable - - - The currently selected item should be highlighted - - - There should be a search field to filter through specific items in the list, with buttons to invert selection, sort alphabetically and revert display. (Features that are provided by the `UIList` class) - -* **Operators** - - - Some buttons should be dynamically disabled (grayed out and impossible to click on) when the context to execute them does not make sense. It is important to note there should not be any heavy computation to determine this since this is executed several times per second for each button where it is implemented. It should only test for simple things and not rely on retrieving information from other modules too much. eg : `Is an item selected ?` `Is the z position of the selected object > 0 ?` or `Is the selected object an IfcOpeningElement ?` and **not** `Is there an IfcOpeningElement in the current file ?` or `How many different classes of IfcBeam are implemented in the file ?` - In Blender this is done in two ways : - - - Directly in the operator `poll` method which is executed when the button is displayed in the interface. The drawback is that some operators rely on custom attributes which are provided only when the user clicks on the button, and cannot be test in the `poll` method. Note in V3.0 we can implement custom messages when the `poll` method fails, depending on the step where the context was not right. - - - In the UI drawing code, where specific layout parts can be disabled. - - - Some buttons or entire interface layout rows or columns may be disabled or hidden at once. It may be desirable when it relies on specific things or combinations of things not being met in the project. In order to avoid UI flicker or the user wondering where the button went, dynamically hiding UI elements should have a minimal interference with the rest of the UI by : - - (1) Hiding the last row(s) of a panel - - (2) Dynamically resizing the rest of the UI when it's not possible to (1) - - The user should be advised why they are prevented to do things via either : - - - A custom message using Blender's report system - - - A label in the UI replacing the missing UI elements - - - A helpful tooltip on an operator - - Generally the context itself should be used to the best of its ability to convey why it's possible to do some things or not. The separation of concerns in multiple different dynamically hidden-or-shown sub-panels should help limit confusion. - - - The user should be forbidden to click on buttons when its execution returns early and does nothing. If a button is clickable and the user clicks on it, there should always be some kind of feedback. - -Icons -^^^^^ - -* .. image:: https://user-images.githubusercontent.com/25156105/137270452-bf6c03ea-2d3e-4ae3-8121-6799e8beb335.png - -**Icon name** : `"CANCEL"` - -**Use** : To disable the edition state of a particular item. - -**Expected result** : A part of the interface showing the item attributes is either shrunk down or hidden. The button is usually replaced by a button to delete this item. - -* .. image:: https://user-images.githubusercontent.com/25156105/137271575-dcae9e56-3c64-4d8b-89b0-6cf103b999f2.png - -**Icon name** : `"X"` - -**Use** : To delete a particular item, for instance an element of a list. - -**Expected result** : The interface element referencing the deleted item is hidden from the interface. If the item was in a list, and the deleted element was selected, the next element becomes selected, or if there is no next element, no element is selected. - -* .. image:: https://user-images.githubusercontent.com/25156105/137271601-e79012e5-fc61-402e-830c-b34b4ca757a0.png - -**Icon name** : `"GREASEPENCIL"` - -**Use** : To Enable the edition of a particular item. - -**Behaviour** : Usually only one element of a particular context can be edited at a time. - -**Expected result** : The interface should either expand or spawn new elements to display the chosen item's editable attributes. If the editem item is part of a list and its interface elements contained an operator to delete it, it is swapped for an operator to disable the edition of that item. - -**Proposal** : Currently all the edition buttons are hidden from the interface when editing a particular item. This results on buttons jumping to the right slightly. My proposal is to instead show but disable the other buttons to prevent interface flicker. - -**Current** : https://user-images.githubusercontent.com/25156105/137273603-f9ac39e5-7616-4fb9-89e2-4dae453e650a.gif - -**Proposal** : https://user-images.githubusercontent.com/25156105/137273329-532d6d59-e39d-483e-980b-b8405062eaa8.gif - -.. image:: https://user-images.githubusercontent.com/25156105/137273981-26fa664a-a29e-402e-9d7e-67b8b71c2d5d.png - -* **Icon name** : `"ADD"` - -**Use** : To add an item to a particular context, either initializing it (eg. adding a coordinate system) or adding an element to a list. - -**Expected result** : The interface should either expand to display the new item or a new line should be shown if the item is added in a list. - -**Proposal** : In some instances adding an element in a list automatically enables the edition of this item's attributes. (eg IFC Groups) but in other instances it does not (eg IFC strucural load cases). It is arguable but I do not think the user should expect a new item to be in editable state right off the bat when they add it to a list. - -* .. image:: https://user-images.githubusercontent.com/25156105/137274869-0d0b876a-545c-4a58-a386-90f85764b7cc.png - -**Icon name** : `"RESTRICT_SELECT_OFF"` - -**Use** : To select all the instances related to a particular item. - -**Expected result** : All the objects relating to a particular item should be selected in the 3D viewport and/or in the outline. - -**Proposal** : Whether or not previously selected objects should be deselected beforehand is up for debate I think, because both behaviours can be desirable. It also raises the question of which object should be set to active. (Random ? First one ? Biggest one ?...) - -* .. image:: https://user-images.githubusercontent.com/25156105/137275582-98c1dfcc-fc96-41d6-80dd-fdb82796e66e.png - -**Icon name** : `"IMPORT"` - -**Use** : to import a particular file from the user's computer's directory to the current context - -**Expected result** : A new file browser window should open, with sufficient information provided to the user to know which file type should be loaded in (eg adding a file extension, adding information in the filebrowser UI). When the file is loaded, the interface should expand to show the attributes or information or new context-sensitive operations provided by the imported file. - -**Proposal** : Currently there are some instances where I don't know if the elements are supposed to require an external file, eg - -.. image:: https://user-images.githubusercontent.com/25156105/137275887-e0f0b694-842b-422f-bc09-cdcefef64107.png - -* .. image:: https://user-images.githubusercontent.com/25156105/137276333-4d083f6a-36b9-494f-b0de-ec1d321cbd3d.png - -**Icon name** : `"EXPORT"` - -**Use** : To export a particular file to the user's computer's directory - -**Expected result** : A new file browser window should open, with sufficient information provided to the user to know which file type is going to be saved (eg adding a file extension, adding information in the filebrowser UI). - -**Proposal** : When there is no actual file to be saved in the user's directory or the filepath is already set in another place in the UI : - -.. image:: https://user-images.githubusercontent.com/25156105/137276840-3ceda0cd-87bd-45f5-8488-bfce86bf3d84.png - -It may be better to use a save icon of some sort instead, eg - -.. image:: https://user-images.githubusercontent.com/25156105/137276758-5d60f0ca-5a93-4af3-9c4f-30c5794e0657.png - -* .. image:: https://user-images.githubusercontent.com/25156105/137277047-bd45df5b-3b47-4b2c-aa29-a340b0710345.png - -**Icon name** : `"FILEBROWSER"` - -**Use** : To Provide the current context with the path to a particular file or folder - -**Expected result** : A new file browser window should open, with sufficient information provided to the user to know which file type is required (eg adding a file extension, adding information in the filebrowser UI). Upon file or folder selection, this should populate a field in the current interface context with the path to the selected file or folder, or at least let the user know that the required information is now correctly filled in. - -* .. image:: https://user-images.githubusercontent.com/25156105/137277374-fa7ff310-0b41-49a9-98bd-7c4686da05fd.png - -**Icon name** : `"EYEDROPPER"` - -**Use** : To select a particular object in the interface to fill the field it is attached to - -**Expected result** : The cursor should change to an eyedropper until the user clicks on the required item. The user should be made aware after selection if it was successful (associated field being filled) or unsuccessful (message ? or field staying empty) diff --git a/src/bonsai/docs/users/modeling/ifc_concepts/classification_and_types.rst b/src/bonsai/docs/guides/authoring/classification_and_types.rst similarity index 100% rename from src/bonsai/docs/users/modeling/ifc_concepts/classification_and_types.rst rename to src/bonsai/docs/guides/authoring/classification_and_types.rst diff --git a/src/bonsai/docs/users/modeling/basic_modeling/creating_walls.rst b/src/bonsai/docs/guides/authoring/creating_walls.rst similarity index 100% rename from src/bonsai/docs/users/modeling/basic_modeling/creating_walls.rst rename to src/bonsai/docs/guides/authoring/creating_walls.rst diff --git a/src/bonsai/docs/users/modeling/basic_modeling/defining_rooms_spaces.rst b/src/bonsai/docs/guides/authoring/defining_rooms_spaces.rst similarity index 100% rename from src/bonsai/docs/users/modeling/basic_modeling/defining_rooms_spaces.rst rename to src/bonsai/docs/guides/authoring/defining_rooms_spaces.rst diff --git a/src/bonsai/docs/users/modeling/basic_modeling/openings/door.rst b/src/bonsai/docs/guides/authoring/door.rst similarity index 100% rename from src/bonsai/docs/users/modeling/basic_modeling/openings/door.rst rename to src/bonsai/docs/guides/authoring/door.rst diff --git a/src/bonsai/docs/users/modeling/ifc_concepts/geometry_and_representations.rst b/src/bonsai/docs/guides/authoring/geometry_and_representations.rst similarity index 100% rename from src/bonsai/docs/users/modeling/ifc_concepts/geometry_and_representations.rst rename to src/bonsai/docs/guides/authoring/geometry_and_representations.rst diff --git a/src/bonsai/docs/users/advanced/georeferencing.rst b/src/bonsai/docs/guides/authoring/georeferencing.rst similarity index 100% rename from src/bonsai/docs/users/advanced/georeferencing.rst rename to src/bonsai/docs/guides/authoring/georeferencing.rst diff --git a/src/bonsai/docs/users/git_support.rst b/src/bonsai/docs/guides/authoring/git_support.rst similarity index 100% rename from src/bonsai/docs/users/git_support.rst rename to src/bonsai/docs/guides/authoring/git_support.rst diff --git a/src/bonsai/docs/users/advanced/images/blenderoffset.png b/src/bonsai/docs/guides/authoring/images/blenderoffset.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/blenderoffset.png rename to src/bonsai/docs/guides/authoring/images/blenderoffset.png diff --git a/src/bonsai/docs/users/advanced/images/coordinateconversion.png b/src/bonsai/docs/guides/authoring/images/coordinateconversion.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/coordinateconversion.png rename to src/bonsai/docs/guides/authoring/images/coordinateconversion.png diff --git a/src/bonsai/docs/users/modeling/images/file_new-ifc-project-submenu.png b/src/bonsai/docs/guides/authoring/images/file_new-ifc-project-submenu.png similarity index 100% rename from src/bonsai/docs/users/modeling/images/file_new-ifc-project-submenu.png rename to src/bonsai/docs/guides/authoring/images/file_new-ifc-project-submenu.png diff --git a/src/bonsai/docs/users/advanced/images/manualorigin.png b/src/bonsai/docs/guides/authoring/images/manualorigin.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/manualorigin.png rename to src/bonsai/docs/guides/authoring/images/manualorigin.png diff --git a/src/bonsai/docs/users/advanced/images/mapconversion.png b/src/bonsai/docs/guides/authoring/images/mapconversion.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/mapconversion.png rename to src/bonsai/docs/guides/authoring/images/mapconversion.png diff --git a/src/bonsai/docs/users/advanced/images/mapcoordinates.png b/src/bonsai/docs/guides/authoring/images/mapcoordinates.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/mapcoordinates.png rename to src/bonsai/docs/guides/authoring/images/mapcoordinates.png diff --git a/src/bonsai/docs/users/advanced/images/offsetmode.png b/src/bonsai/docs/guides/authoring/images/offsetmode.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/offsetmode.png rename to src/bonsai/docs/guides/authoring/images/offsetmode.png diff --git a/src/bonsai/docs/users/modeling/images/outliner.png b/src/bonsai/docs/guides/authoring/images/outliner.png similarity index 100% rename from src/bonsai/docs/users/modeling/images/outliner.png rename to src/bonsai/docs/guides/authoring/images/outliner.png diff --git a/src/bonsai/docs/users/modeling/images/project-info_unsaved.png b/src/bonsai/docs/guides/authoring/images/project-info_unsaved.png similarity index 100% rename from src/bonsai/docs/users/modeling/images/project-info_unsaved.png rename to src/bonsai/docs/guides/authoring/images/project-info_unsaved.png diff --git a/src/bonsai/docs/users/modeling/images/project_wizard.png b/src/bonsai/docs/guides/authoring/images/project_wizard.png similarity index 100% rename from src/bonsai/docs/users/modeling/images/project_wizard.png rename to src/bonsai/docs/guides/authoring/images/project_wizard.png diff --git a/src/bonsai/docs/users/advanced/images/projectedcrs.png b/src/bonsai/docs/guides/authoring/images/projectedcrs.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/projectedcrs.png rename to src/bonsai/docs/guides/authoring/images/projectedcrs.png diff --git a/src/bonsai/docs/users/advanced/images/truenorth.png b/src/bonsai/docs/guides/authoring/images/truenorth.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/truenorth.png rename to src/bonsai/docs/guides/authoring/images/truenorth.png diff --git a/src/bonsai/docs/users/advanced/images/xaxisabscissaordinate.png b/src/bonsai/docs/guides/authoring/images/xaxisabscissaordinate.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/xaxisabscissaordinate.png rename to src/bonsai/docs/guides/authoring/images/xaxisabscissaordinate.png diff --git a/src/bonsai/docs/users/modeling/ifc_modeling.rst b/src/bonsai/docs/guides/authoring/index.rst similarity index 90% rename from src/bonsai/docs/users/modeling/ifc_modeling.rst rename to src/bonsai/docs/guides/authoring/index.rst index 3ad3804ea3..157bce093a 100644 --- a/src/bonsai/docs/users/modeling/ifc_modeling.rst +++ b/src/bonsai/docs/guides/authoring/index.rst @@ -1,6 +1,5 @@ -============ -IFC modeling -============ +Authoring models +================ This chapter covers the essential aspects of working with Industry Foundation Classes (IFC) in Bonsai. It is divided into five main sections: @@ -54,13 +53,8 @@ This chapter covers the essential aspects of working with Industry Foundation Cl .. toctree:: :hidden: - :caption: IFC Modeling :maxdepth: 2 - understanding_ifc - importing_viewing_models - starting_new_project - basic_modeling/index - advanced_modeling/index - - + georeferencing + git_support + other_addons diff --git a/src/bonsai/docs/users/modeling/advanced_modeling/material_assignment.rst b/src/bonsai/docs/guides/authoring/material_assignment.rst similarity index 100% rename from src/bonsai/docs/users/modeling/advanced_modeling/material_assignment.rst rename to src/bonsai/docs/guides/authoring/material_assignment.rst diff --git a/src/bonsai/docs/users/modeling/basic_modeling/modeling_slabs_roofs.rst b/src/bonsai/docs/guides/authoring/modeling_slabs_roofs.rst similarity index 100% rename from src/bonsai/docs/users/modeling/basic_modeling/modeling_slabs_roofs.rst rename to src/bonsai/docs/guides/authoring/modeling_slabs_roofs.rst diff --git a/src/bonsai/docs/users/modeling/basic_modeling/openings/opening.rst b/src/bonsai/docs/guides/authoring/opening.rst similarity index 100% rename from src/bonsai/docs/users/modeling/basic_modeling/openings/opening.rst rename to src/bonsai/docs/guides/authoring/opening.rst diff --git a/src/bonsai/docs/users/other_addons.rst b/src/bonsai/docs/guides/authoring/other_addons.rst similarity index 100% rename from src/bonsai/docs/users/other_addons.rst rename to src/bonsai/docs/guides/authoring/other_addons.rst diff --git a/src/bonsai/docs/users/modeling/advanced_modeling/parametric_geometry.rst b/src/bonsai/docs/guides/authoring/parametric_geometry.rst similarity index 100% rename from src/bonsai/docs/users/modeling/advanced_modeling/parametric_geometry.rst rename to src/bonsai/docs/guides/authoring/parametric_geometry.rst diff --git a/src/bonsai/docs/users/modeling/ifc_concepts/spatial_objects.rst b/src/bonsai/docs/guides/authoring/spatial_objects.rst similarity index 100% rename from src/bonsai/docs/users/modeling/ifc_concepts/spatial_objects.rst rename to src/bonsai/docs/guides/authoring/spatial_objects.rst diff --git a/src/bonsai/docs/users/modeling/starting_new_project.rst b/src/bonsai/docs/guides/authoring/starting_new_project.rst similarity index 100% rename from src/bonsai/docs/users/modeling/starting_new_project.rst rename to src/bonsai/docs/guides/authoring/starting_new_project.rst diff --git a/src/bonsai/docs/users/modeling/understanding_ifc.rst b/src/bonsai/docs/guides/authoring/understanding_ifc.rst similarity index 100% rename from src/bonsai/docs/users/modeling/understanding_ifc.rst rename to src/bonsai/docs/guides/authoring/understanding_ifc.rst diff --git a/src/bonsai/docs/users/modeling/basic_modeling/openings/window.rst b/src/bonsai/docs/guides/authoring/window.rst similarity index 100% rename from src/bonsai/docs/users/modeling/basic_modeling/openings/window.rst rename to src/bonsai/docs/guides/authoring/window.rst diff --git a/src/bonsai/docs/users/modeling/ifc_concepts/working_with_representations.rst b/src/bonsai/docs/guides/authoring/working_with_representations.rst similarity index 100% rename from src/bonsai/docs/users/modeling/ifc_concepts/working_with_representations.rst rename to src/bonsai/docs/guides/authoring/working_with_representations.rst diff --git a/src/bonsai/docs/guides/coordination/index.rst b/src/bonsai/docs/guides/coordination/index.rst new file mode 100644 index 0000000000..6ff370f31c --- /dev/null +++ b/src/bonsai/docs/guides/coordination/index.rst @@ -0,0 +1,4 @@ +Coordination +============ + +TODO diff --git a/src/bonsai/docs/users/costing_and_scheduling/index.rst b/src/bonsai/docs/guides/costing_and_scheduling/index.rst similarity index 97% rename from src/bonsai/docs/users/costing_and_scheduling/index.rst rename to src/bonsai/docs/guides/costing_and_scheduling/index.rst index 274533a1bf..d8095a561e 100644 --- a/src/bonsai/docs/users/costing_and_scheduling/index.rst +++ b/src/bonsai/docs/guides/costing_and_scheduling/index.rst @@ -1,4 +1,4 @@ -Costing and Scheduling +Costing and scheduling ====================== This section covers the cost estimation and project scheduling features in Bonsai. diff --git a/src/bonsai/docs/devs/hello_world.rst b/src/bonsai/docs/guides/development/hello_world.rst similarity index 100% rename from src/bonsai/docs/devs/hello_world.rst rename to src/bonsai/docs/guides/development/hello_world.rst diff --git a/src/bonsai/docs/devs/images/architecture.png b/src/bonsai/docs/guides/development/images/architecture.png similarity index 100% rename from src/bonsai/docs/devs/images/architecture.png rename to src/bonsai/docs/guides/development/images/architecture.png diff --git a/src/bonsai/docs/devs/images/demo-module.png b/src/bonsai/docs/guides/development/images/demo-module.png similarity index 100% rename from src/bonsai/docs/devs/images/demo-module.png rename to src/bonsai/docs/guides/development/images/demo-module.png diff --git a/src/bonsai/docs/devs/images/diagrams.svg b/src/bonsai/docs/guides/development/images/diagrams.svg similarity index 100% rename from src/bonsai/docs/devs/images/diagrams.svg rename to src/bonsai/docs/guides/development/images/diagrams.svg diff --git a/src/bonsai/docs/contribute/images/documentation-style.png b/src/bonsai/docs/guides/development/images/documentation-style.png similarity index 100% rename from src/bonsai/docs/contribute/images/documentation-style.png rename to src/bonsai/docs/guides/development/images/documentation-style.png diff --git a/src/bonsai/docs/devs/images/github-editing.png b/src/bonsai/docs/guides/development/images/github-editing.png similarity index 100% rename from src/bonsai/docs/devs/images/github-editing.png rename to src/bonsai/docs/guides/development/images/github-editing.png diff --git a/src/bonsai/docs/devs/images/ifcopenshell-architecture.png b/src/bonsai/docs/guides/development/images/ifcopenshell-architecture.png similarity index 100% rename from src/bonsai/docs/devs/images/ifcopenshell-architecture.png rename to src/bonsai/docs/guides/development/images/ifcopenshell-architecture.png diff --git a/src/bonsai/docs/devs/images/module-architecture.png b/src/bonsai/docs/guides/development/images/module-architecture.png similarity index 100% rename from src/bonsai/docs/devs/images/module-architecture.png rename to src/bonsai/docs/guides/development/images/module-architecture.png diff --git a/src/bonsai/docs/devs/images/native-openbim.png b/src/bonsai/docs/guides/development/images/native-openbim.png similarity index 100% rename from src/bonsai/docs/devs/images/native-openbim.png rename to src/bonsai/docs/guides/development/images/native-openbim.png diff --git a/src/bonsai/docs/contribute/images/translation-panel.png b/src/bonsai/docs/guides/development/images/translation-panel.png similarity index 100% rename from src/bonsai/docs/contribute/images/translation-panel.png rename to src/bonsai/docs/guides/development/images/translation-panel.png diff --git a/src/bonsai/docs/guides/development/index.rst b/src/bonsai/docs/guides/development/index.rst new file mode 100644 index 0000000000..e25659178b --- /dev/null +++ b/src/bonsai/docs/guides/development/index.rst @@ -0,0 +1,16 @@ +Development +=========== + +This chapter covers how you can help contribute to Bonsai. + +.. container:: global-index-toc + + .. toctree:: + :hidden: + :maxdepth: 2 + + hello_world + running_tests + translations + undo_system + writing_docs diff --git a/src/bonsai/docs/devs/installation.rst b/src/bonsai/docs/guides/development/installation.rst similarity index 100% rename from src/bonsai/docs/devs/installation.rst rename to src/bonsai/docs/guides/development/installation.rst diff --git a/src/bonsai/docs/devs/running_tests.rst b/src/bonsai/docs/guides/development/running_tests.rst similarity index 94% rename from src/bonsai/docs/devs/running_tests.rst rename to src/bonsai/docs/guides/development/running_tests.rst index 4a7ca542cf..b5ae06bf74 100644 --- a/src/bonsai/docs/devs/running_tests.rst +++ b/src/bonsai/docs/guides/development/running_tests.rst @@ -127,3 +127,14 @@ test georeferencing features: ``Edit > Preferences > Add-ons`` and install # If you're on Windows, and don't want to use make, use: pytest test/bim # Test everything pytest test/bim -m "foo" ./ --maxfail=1 # Only test a single module + +Code styling +------------ + +`Black `__ is used for code +formatting. The settings for black are configured in the ``pyproject.toml`` at +the project root. At the project root, just run: + +.. code-block:: bash + + black . diff --git a/src/bonsai/docs/contribute/translations.rst b/src/bonsai/docs/guides/development/translations.rst similarity index 100% rename from src/bonsai/docs/contribute/translations.rst rename to src/bonsai/docs/guides/development/translations.rst diff --git a/src/bonsai/docs/devs/undo_system.rst b/src/bonsai/docs/guides/development/undo_system.rst similarity index 100% rename from src/bonsai/docs/devs/undo_system.rst rename to src/bonsai/docs/guides/development/undo_system.rst diff --git a/src/bonsai/docs/contribute/writing_docs.rst b/src/bonsai/docs/guides/development/writing_docs.rst similarity index 80% rename from src/bonsai/docs/contribute/writing_docs.rst rename to src/bonsai/docs/guides/development/writing_docs.rst index dca181b982..a3a4fe9665 100644 --- a/src/bonsai/docs/contribute/writing_docs.rst +++ b/src/bonsai/docs/guides/development/writing_docs.rst @@ -1,13 +1,35 @@ -Contribute to this Manual -========================= +Writing documentation +===================== A great way to contribute without writing code is to help writing documentation. Please reach out before contributing as the software is still in an alpha state and portions may not be worth documenting as it changes too frequently. -Writing technical documentation -------------------------------- +Philosophy +---------- + +The documentation is split into three sections: + +1. **Quickstart**: a crash course where a user should be able to go from + nothing to doing the most basic, common tasks. It is not comprehensive, but + a highly focused tutorial style "taster" of what's available. It should be + kept very short, aiming to acquaint new users within an hour. +2. **Guides**: a guidebook style, topic-driven series of articles discussing + things of interest, or tutorials that cover common workflows. This should + contain lots of images. +3. **Reference**: a comprehensive index of the entire interface and all + available features. + +Documentation should not be a guide to IFC. Users should not have to know what +IFC is. + +Official documentation should be polished and maintained. Less documentation of +a higher quality that is kept updated with every release is preferred to more +documentation with stubs, incomplete or inaccurate information. + +Syntax +------ All documentation is written in ReStructured Text and is available in the `Bonsai docs directory diff --git a/src/bonsai/docs/users/drawing/index.rst b/src/bonsai/docs/guides/drawings/index.rst similarity index 98% rename from src/bonsai/docs/users/drawing/index.rst rename to src/bonsai/docs/guides/drawings/index.rst index 31e65064b5..15e0f79b1e 100644 --- a/src/bonsai/docs/users/drawing/index.rst +++ b/src/bonsai/docs/guides/drawings/index.rst @@ -1,5 +1,5 @@ ====================== -Drawings and Documents +Drawings and documents ====================== Bonsai provides powerful tools for generating 2D drawings from your 3D BIM models and adding detailed annotations. diff --git a/src/bonsai/docs/guides/facility_management/index.rst b/src/bonsai/docs/guides/facility_management/index.rst new file mode 100644 index 0000000000..7db982a682 --- /dev/null +++ b/src/bonsai/docs/guides/facility_management/index.rst @@ -0,0 +1,4 @@ +Facility management +=================== + +TODO diff --git a/src/bonsai/docs/users/images/error-message.png b/src/bonsai/docs/guides/images/error-message.png similarity index 100% rename from src/bonsai/docs/users/images/error-message.png rename to src/bonsai/docs/guides/images/error-message.png diff --git a/src/bonsai/docs/users/images/uninstall.png b/src/bonsai/docs/guides/images/uninstall.png similarity index 100% rename from src/bonsai/docs/users/images/uninstall.png rename to src/bonsai/docs/guides/images/uninstall.png diff --git a/src/bonsai/docs/users/images/update.png b/src/bonsai/docs/guides/images/update.png similarity index 100% rename from src/bonsai/docs/users/images/update.png rename to src/bonsai/docs/guides/images/update.png diff --git a/src/bonsai/docs/guides/services/index.rst b/src/bonsai/docs/guides/services/index.rst new file mode 100644 index 0000000000..3bd2da24a2 --- /dev/null +++ b/src/bonsai/docs/guides/services/index.rst @@ -0,0 +1,4 @@ +Services and systems +==================== + +TODO diff --git a/src/bonsai/docs/users/structural_analysis/index.rst b/src/bonsai/docs/guides/structural_analysis/index.rst similarity index 97% rename from src/bonsai/docs/users/structural_analysis/index.rst rename to src/bonsai/docs/guides/structural_analysis/index.rst index 40c05d7b9a..cb231a7021 100644 --- a/src/bonsai/docs/users/structural_analysis/index.rst +++ b/src/bonsai/docs/guides/structural_analysis/index.rst @@ -1,4 +1,4 @@ -Structural Analysis +Structural analysis =================== This section covers the structural analysis capabilities in Bonsai. diff --git a/src/bonsai/docs/users/troubleshooting.rst b/src/bonsai/docs/guides/troubleshooting.rst similarity index 100% rename from src/bonsai/docs/users/troubleshooting.rst rename to src/bonsai/docs/guides/troubleshooting.rst diff --git a/src/bonsai/docs/users/advanced/dealing_with_large_models.rst b/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst similarity index 100% rename from src/bonsai/docs/users/advanced/dealing_with_large_models.rst rename to src/bonsai/docs/guides/viewing/dealing_with_large_models.rst diff --git a/src/bonsai/docs/users/advanced/images/advanced-mode-settings.png b/src/bonsai/docs/guides/viewing/images/advanced-mode-settings.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/advanced-mode-settings.png rename to src/bonsai/docs/guides/viewing/images/advanced-mode-settings.png diff --git a/src/bonsai/docs/users/advanced/images/advanced-mode.png b/src/bonsai/docs/guides/viewing/images/advanced-mode.png similarity index 100% rename from src/bonsai/docs/users/advanced/images/advanced-mode.png rename to src/bonsai/docs/guides/viewing/images/advanced-mode.png diff --git a/src/bonsai/docs/guides/viewing/index.rst b/src/bonsai/docs/guides/viewing/index.rst new file mode 100644 index 0000000000..a505f6cc13 --- /dev/null +++ b/src/bonsai/docs/guides/viewing/index.rst @@ -0,0 +1,12 @@ +Viewing models +============== + +This chapter covers how to navigate and explore models. + +.. container:: global-index-toc + + .. toctree:: + :hidden: + :maxdepth: 2 + + dealing_with_large_models diff --git a/src/bonsai/docs/images/bonsai-rabbit.png b/src/bonsai/docs/images/bonsai-rabbit.png new file mode 100644 index 0000000000..06b5f3a742 Binary files /dev/null and b/src/bonsai/docs/images/bonsai-rabbit.png differ diff --git a/src/bonsai/docs/index.rst b/src/bonsai/docs/index.rst index 2898373151..134f73c1f2 100644 --- a/src/bonsai/docs/index.rst +++ b/src/bonsai/docs/index.rst @@ -1,8 +1,11 @@ Learn Bonsai ============ -Welcome to the manual for `Bonsai `__, the free and open -source BIM add-on for Blender. +Discover `Bonsai `__, an add-on for beautiful, detailed, +and data-rich OpenBIM with Blender :) + +.. image:: images/bonsai-rabbit.png + :class: transparent .. only:: builder_html and (not singlehtml) @@ -10,23 +13,26 @@ source BIM add-on for Blender. .. container:: card - :doc:`/users/quickstart/introduction_to_bim` (2-minute read) - Brief overview of BIM concepts and Bonsai's role. + :doc:`/quickstart/introduction_to_bim` (2 minute read) + Discover how Bonsai can model and describe our built environment + using Building Information Modeling. .. container:: card - :doc:`/users/quickstart/installation` (5 to 10-minute process) - Installation guide and system requirements. + :doc:`/quickstart/installation` (5 minute process) + Install Blender and Bonsai on your computer. No administrator + rights required! .. container:: card - :doc:`/users/quickstart/explore_model` (15-minute guide) - Load and navigate an IFC model. + :doc:`/quickstart/explore_model` (15 minute tutorial) + Open and view an IFC, and explore the most useful properties and + relationships. .. container:: card - :doc:`/users/quickstart/create_model` (20-minute guide) - Create a simple BIM project. + :doc:`/quickstart/create_model` (20 minute tutorial) + Begin modeling simple objects, walls, slabs, doors, and windows. .. container:: global-index-toc @@ -35,176 +41,39 @@ source BIM add-on for Blender. :caption: Quickstart :maxdepth: 1 - users/quickstart/introduction_to_bim - users/quickstart/installation - users/quickstart/explore_model - users/quickstart/create_model - users/quickstart/next_steps - -Sections -======== - -.. only:: builder_html and (not singlehtml) - - .. container:: toc-cards - - .. container:: card - - :doc:`/users/modeling/interface` - Guide to the Bonsai interface. - - .. container:: card - - :doc:`/users/modeling/ifc_modeling` - IFC modeling techniques and concepts. - - .. container:: card - - :doc:`/users/git_support` - Collaborate on projects using Git - - .. container:: card - - :doc:`/users/drawing/index` - 2D drawing generation and annotation. - - .. container:: card - - :doc:`/users/structural_analysis/index` - Structural analysis capabilities. - - .. container:: card - - :doc:`/users/costing_and_scheduling/index` - Cost estimation and project scheduling features. - - .. container:: card - - :doc:`/users/advanced/index` - Advanced topics and large-scale modeling. - - .. container:: card - - :doc:`/users/tutorials/index` - Real-world BIM project tutorials. - - .. container:: card - - :doc:`/users/user_interface` - Detailed UI reference. - - .. container:: card - - :doc:`/users/other_addons` - Other complementary add-ons - - .. container:: card - - :doc:`/users/troubleshooting` - Troubleshooting when things go wrong - -.. container:: global-index-toc + quickstart/introduction_to_bim + quickstart/installation + quickstart/explore_model + quickstart/create_model + quickstart/next_steps .. toctree:: :hidden: - :caption: Sections + :caption: Guides :maxdepth: 2 - users/modeling/interface - users/modeling/ifc_modeling - users/git_support - users/drawing/index - users/structural_analysis/index - users/costing_and_scheduling/index - users/advanced/index - users/tutorials/index - users/user_interface - users/other_addons - users/troubleshooting - -Get Involved -============ - -This manual is maintained largely by volunteers. - -Please consider joining the effort and :doc:`/contribute/writing_docs`. - -You can also can help with :doc:`Translations and Internationalisation ` - -For users who want to contribute to the Bonsai codebase, -please refer to the :doc:`Documentation for Developers `. -This part of the documentation covers various aspects of the Bonsai development process. - -You can get in touch by `joining the chat `__. - -.. toctree:: - :hidden: - :caption: Get Involved - :maxdepth: 1 - - contribute/writing_docs - contribute/translations - - -Developer Documentation -======================= - -Bonsai is an open-source project, and its development is driven by the contributions of a dedicated community of developers, -architects, engineers, and enthusiasts. If you're interested in contributing to the project, whether by submitting bug reports, -suggesting new features, or contributing code, your involvement is highly encouraged and appreciated. - - - -.. only:: builder_html and (not singlehtml) - - .. container:: toc-cards - - .. container:: card - - :doc:`/devs/getting_started` - Introduction to contributing to Bonsai. - - .. container:: card - - :doc:`/devs/installation` - Setting up a development environment. - - .. container:: card - - :doc:`/devs/hello_world` - Understanding the project structure. - - .. container:: card - - :doc:`/devs/undo_system` - Working with Bonsai's undo system. - - .. container:: card - - :doc:`/devs/code_style` - Code style guidelines and best practices. - - .. container:: card - - :doc:`/devs/running_tests` - Testing and quality assurance. - - .. container:: card - - :doc:`/devs/ux_guidelines` - User experience and interface guidelines. - -.. container:: global-index-toc + guides/viewing/index + guides/authoring/index + guides/drawings/index + guides/structural_analysis/index + guides/services/index + guides/costing_and_scheduling/index + guides/facility_management/index + guides/coordination/index + guides/development/index + guides/troubleshooting .. toctree:: :hidden: - :caption: Developer Documentation - :maxdepth: 1 + :caption: Reference + :maxdepth: 2 - devs/getting_started - devs/installation - devs/hello_world - devs/undo_system - devs/code_style - devs/running_tests - devs/ux_guidelines + reference/workspace + reference/properties + +Need more help? Join the `live chat `__ or `community +forums `__. Something strange happening? Please +`report a bug `__. Want to +improve the software? Help with :doc:`coding ` or `chip +in financially `__. Every little bit +adds up! diff --git a/src/bonsai/docs/users/quickstart/create_model.rst b/src/bonsai/docs/quickstart/create_model.rst similarity index 100% rename from src/bonsai/docs/users/quickstart/create_model.rst rename to src/bonsai/docs/quickstart/create_model.rst diff --git a/src/bonsai/docs/users/quickstart/explore_model.rst b/src/bonsai/docs/quickstart/explore_model.rst similarity index 100% rename from src/bonsai/docs/users/quickstart/explore_model.rst rename to src/bonsai/docs/quickstart/explore_model.rst diff --git a/src/bonsai/docs/users/quickstart/images/add-cube.png b/src/bonsai/docs/quickstart/images/add-cube.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/add-cube.png rename to src/bonsai/docs/quickstart/images/add-cube.png diff --git a/src/bonsai/docs/users/quickstart/images/assign-class.png b/src/bonsai/docs/quickstart/images/assign-class.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/assign-class.png rename to src/bonsai/docs/quickstart/images/assign-class.png diff --git a/src/bonsai/docs/users/quickstart/images/attributes.png b/src/bonsai/docs/quickstart/images/attributes.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/attributes.png rename to src/bonsai/docs/quickstart/images/attributes.png diff --git a/src/bonsai/docs/users/quickstart/images/bonsai-layout.png b/src/bonsai/docs/quickstart/images/bonsai-layout.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/bonsai-layout.png rename to src/bonsai/docs/quickstart/images/bonsai-layout.png diff --git a/src/bonsai/docs/users/quickstart/images/create-project.png b/src/bonsai/docs/quickstart/images/create-project.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/create-project.png rename to src/bonsai/docs/quickstart/images/create-project.png diff --git a/src/bonsai/docs/users/quickstart/images/default-spatial-tree.png b/src/bonsai/docs/quickstart/images/default-spatial-tree.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/default-spatial-tree.png rename to src/bonsai/docs/quickstart/images/default-spatial-tree.png diff --git a/src/bonsai/docs/users/quickstart/images/dimensions.png b/src/bonsai/docs/quickstart/images/dimensions.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/dimensions.png rename to src/bonsai/docs/quickstart/images/dimensions.png diff --git a/src/bonsai/docs/users/quickstart/images/element-class-select.png b/src/bonsai/docs/quickstart/images/element-class-select.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/element-class-select.png rename to src/bonsai/docs/quickstart/images/element-class-select.png diff --git a/src/bonsai/docs/users/quickstart/images/element-class.png b/src/bonsai/docs/quickstart/images/element-class.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/element-class.png rename to src/bonsai/docs/quickstart/images/element-class.png diff --git a/src/bonsai/docs/users/quickstart/images/example-project.png b/src/bonsai/docs/quickstart/images/example-project.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/example-project.png rename to src/bonsai/docs/quickstart/images/example-project.png diff --git a/src/bonsai/docs/users/quickstart/images/frame-selected.png b/src/bonsai/docs/quickstart/images/frame-selected.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/frame-selected.png rename to src/bonsai/docs/quickstart/images/frame-selected.png diff --git a/src/bonsai/docs/users/quickstart/images/ifc-pipeline.png b/src/bonsai/docs/quickstart/images/ifc-pipeline.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/ifc-pipeline.png rename to src/bonsai/docs/quickstart/images/ifc-pipeline.png diff --git a/src/bonsai/docs/users/quickstart/images/install-bonsai-1.png b/src/bonsai/docs/quickstart/images/install-bonsai-1.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/install-bonsai-1.png rename to src/bonsai/docs/quickstart/images/install-bonsai-1.png diff --git a/src/bonsai/docs/users/quickstart/images/install-bonsai-2.png b/src/bonsai/docs/quickstart/images/install-bonsai-2.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/install-bonsai-2.png rename to src/bonsai/docs/quickstart/images/install-bonsai-2.png diff --git a/src/bonsai/docs/users/quickstart/images/install-bonsai-3.png b/src/bonsai/docs/quickstart/images/install-bonsai-3.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/install-bonsai-3.png rename to src/bonsai/docs/quickstart/images/install-bonsai-3.png diff --git a/src/bonsai/docs/users/quickstart/images/install-bonsai-4.png b/src/bonsai/docs/quickstart/images/install-bonsai-4.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/install-bonsai-4.png rename to src/bonsai/docs/quickstart/images/install-bonsai-4.png diff --git a/src/bonsai/docs/users/quickstart/images/install-bonsai-5.png b/src/bonsai/docs/quickstart/images/install-bonsai-5.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/install-bonsai-5.png rename to src/bonsai/docs/quickstart/images/install-bonsai-5.png diff --git a/src/bonsai/docs/users/quickstart/images/materials.png b/src/bonsai/docs/quickstart/images/materials.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/materials.png rename to src/bonsai/docs/quickstart/images/materials.png diff --git a/src/bonsai/docs/users/quickstart/images/measure-tool.png b/src/bonsai/docs/quickstart/images/measure-tool.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/measure-tool.png rename to src/bonsai/docs/quickstart/images/measure-tool.png diff --git a/src/bonsai/docs/users/quickstart/images/navigate-gizmo.png b/src/bonsai/docs/quickstart/images/navigate-gizmo.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/navigate-gizmo.png rename to src/bonsai/docs/quickstart/images/navigate-gizmo.png diff --git a/src/bonsai/docs/users/quickstart/images/outliner-cube.png b/src/bonsai/docs/quickstart/images/outliner-cube.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/outliner-cube.png rename to src/bonsai/docs/quickstart/images/outliner-cube.png diff --git a/src/bonsai/docs/users/quickstart/images/outliner-filter.png b/src/bonsai/docs/quickstart/images/outliner-filter.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/outliner-filter.png rename to src/bonsai/docs/quickstart/images/outliner-filter.png diff --git a/src/bonsai/docs/users/quickstart/images/outliner-isolate.png b/src/bonsai/docs/quickstart/images/outliner-isolate.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/outliner-isolate.png rename to src/bonsai/docs/quickstart/images/outliner-isolate.png diff --git a/src/bonsai/docs/users/quickstart/images/outliner-types.png b/src/bonsai/docs/quickstart/images/outliner-types.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/outliner-types.png rename to src/bonsai/docs/quickstart/images/outliner-types.png diff --git a/src/bonsai/docs/users/quickstart/images/outliner.png b/src/bonsai/docs/quickstart/images/outliner.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/outliner.png rename to src/bonsai/docs/quickstart/images/outliner.png diff --git a/src/bonsai/docs/users/quickstart/images/properties-loadproject.png b/src/bonsai/docs/quickstart/images/properties-loadproject.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/properties-loadproject.png rename to src/bonsai/docs/quickstart/images/properties-loadproject.png diff --git a/src/bonsai/docs/users/quickstart/images/properties-tabs.png b/src/bonsai/docs/quickstart/images/properties-tabs.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/properties-tabs.png rename to src/bonsai/docs/quickstart/images/properties-tabs.png diff --git a/src/bonsai/docs/users/quickstart/images/properties-types.png b/src/bonsai/docs/quickstart/images/properties-types.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/properties-types.png rename to src/bonsai/docs/quickstart/images/properties-types.png diff --git a/src/bonsai/docs/users/quickstart/images/psets.png b/src/bonsai/docs/quickstart/images/psets.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/psets.png rename to src/bonsai/docs/quickstart/images/psets.png diff --git a/src/bonsai/docs/users/quickstart/images/qtos.png b/src/bonsai/docs/quickstart/images/qtos.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/qtos.png rename to src/bonsai/docs/quickstart/images/qtos.png diff --git a/src/bonsai/docs/users/quickstart/images/save-project.png b/src/bonsai/docs/quickstart/images/save-project.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/save-project.png rename to src/bonsai/docs/quickstart/images/save-project.png diff --git a/src/bonsai/docs/users/quickstart/images/scene-statistics.png b/src/bonsai/docs/quickstart/images/scene-statistics.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/scene-statistics.png rename to src/bonsai/docs/quickstart/images/scene-statistics.png diff --git a/src/bonsai/docs/users/quickstart/images/snap-targets.png b/src/bonsai/docs/quickstart/images/snap-targets.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/snap-targets.png rename to src/bonsai/docs/quickstart/images/snap-targets.png diff --git a/src/bonsai/docs/users/quickstart/images/spatial-container.png b/src/bonsai/docs/quickstart/images/spatial-container.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/spatial-container.png rename to src/bonsai/docs/quickstart/images/spatial-container.png diff --git a/src/bonsai/docs/users/quickstart/images/type-local-view.png b/src/bonsai/docs/quickstart/images/type-local-view.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/type-local-view.png rename to src/bonsai/docs/quickstart/images/type-local-view.png diff --git a/src/bonsai/docs/users/quickstart/images/x-ray-mode.png b/src/bonsai/docs/quickstart/images/x-ray-mode.png similarity index 100% rename from src/bonsai/docs/users/quickstart/images/x-ray-mode.png rename to src/bonsai/docs/quickstart/images/x-ray-mode.png diff --git a/src/bonsai/docs/users/quickstart/installation.rst b/src/bonsai/docs/quickstart/installation.rst similarity index 100% rename from src/bonsai/docs/users/quickstart/installation.rst rename to src/bonsai/docs/quickstart/installation.rst diff --git a/src/bonsai/docs/users/quickstart/introduction_to_bim.rst b/src/bonsai/docs/quickstart/introduction_to_bim.rst similarity index 100% rename from src/bonsai/docs/users/quickstart/introduction_to_bim.rst rename to src/bonsai/docs/quickstart/introduction_to_bim.rst diff --git a/src/bonsai/docs/users/quickstart/next_steps.rst b/src/bonsai/docs/quickstart/next_steps.rst similarity index 100% rename from src/bonsai/docs/users/quickstart/next_steps.rst rename to src/bonsai/docs/quickstart/next_steps.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/blender.rst b/src/bonsai/docs/reference/blender.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/blender.rst rename to src/bonsai/docs/reference/blender.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/costing_and_scheduling/images/interface_property-editor_costing-scheduling.png b/src/bonsai/docs/reference/costing_and_scheduling/images/interface_property-editor_costing-scheduling.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/costing_and_scheduling/images/interface_property-editor_costing-scheduling.png rename to src/bonsai/docs/reference/costing_and_scheduling/images/interface_property-editor_costing-scheduling.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/costing_and_scheduling/index.rst b/src/bonsai/docs/reference/costing_and_scheduling/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/costing_and_scheduling/index.rst rename to src/bonsai/docs/reference/costing_and_scheduling/index.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/drawings_and_documents/images/interface_property-editor_drawings-documents.png b/src/bonsai/docs/reference/drawings_and_documents/images/interface_property-editor_drawings-documents.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/drawings_and_documents/images/interface_property-editor_drawings-documents.png rename to src/bonsai/docs/reference/drawings_and_documents/images/interface_property-editor_drawings-documents.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/drawings_and_documents/index.rst b/src/bonsai/docs/reference/drawings_and_documents/index.rst similarity index 76% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/drawings_and_documents/index.rst rename to src/bonsai/docs/reference/drawings_and_documents/index.rst index bd1b77d7b5..b0de4afc84 100644 --- a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/drawings_and_documents/index.rst +++ b/src/bonsai/docs/reference/drawings_and_documents/index.rst @@ -1,10 +1,10 @@ -Drawings and Documents +Drawings and documents ====================== .. figure:: images/interface_property-editor_drawings-documents.png :alt: property editor drawings and documents sub-tab - Drawings ans Documents sub-tab. + Drawings and Documents sub-tab. Sheets tbd @@ -16,4 +16,4 @@ Schedules tbd References - tbd \ No newline at end of file + tbd diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/facility_management/images/interface_property-editor_facility-management.png b/src/bonsai/docs/reference/facility_management/images/interface_property-editor_facility-management.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/facility_management/images/interface_property-editor_facility-management.png rename to src/bonsai/docs/reference/facility_management/images/interface_property-editor_facility-management.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/facility_management/index.rst b/src/bonsai/docs/reference/facility_management/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/facility_management/index.rst rename to src/bonsai/docs/reference/facility_management/index.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/add-representation-dialog.png b/src/bonsai/docs/reference/geometry_and_materials/images/add-representation-dialog.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/add-representation-dialog.png rename to src/bonsai/docs/reference/geometry_and_materials/images/add-representation-dialog.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/geometric_relationships.png b/src/bonsai/docs/reference/geometry_and_materials/images/geometric_relationships.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/geometric_relationships.png rename to src/bonsai/docs/reference/geometry_and_materials/images/geometric_relationships.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/interface_property-editor_geometry-materials.png b/src/bonsai/docs/reference/geometry_and_materials/images/interface_property-editor_geometry-materials.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/interface_property-editor_geometry-materials.png rename to src/bonsai/docs/reference/geometry_and_materials/images/interface_property-editor_geometry-materials.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/materials.png b/src/bonsai/docs/reference/geometry_and_materials/images/materials.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/materials.png rename to src/bonsai/docs/reference/geometry_and_materials/images/materials.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/placement.png b/src/bonsai/docs/reference/geometry_and_materials/images/placement.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/placement.png rename to src/bonsai/docs/reference/geometry_and_materials/images/placement.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/representations.png b/src/bonsai/docs/reference/geometry_and_materials/images/representations.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/representations.png rename to src/bonsai/docs/reference/geometry_and_materials/images/representations.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/window-parametric-geometry.png b/src/bonsai/docs/reference/geometry_and_materials/images/window-parametric-geometry.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/images/window-parametric-geometry.png rename to src/bonsai/docs/reference/geometry_and_materials/images/window-parametric-geometry.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/index.rst b/src/bonsai/docs/reference/geometry_and_materials/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/geometry_and_materials/index.rst rename to src/bonsai/docs/reference/geometry_and_materials/index.rst diff --git a/src/bonsai/docs/users/user_interface/images/file_new-ifc-project-submenu.png b/src/bonsai/docs/reference/images/file_new-ifc-project-submenu.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/file_new-ifc-project-submenu.png rename to src/bonsai/docs/reference/images/file_new-ifc-project-submenu.png diff --git a/src/bonsai/docs/users/user_interface/images/ifc-project-create.png b/src/bonsai/docs/reference/images/ifc-project-create.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/ifc-project-create.png rename to src/bonsai/docs/reference/images/ifc-project-create.png diff --git a/src/bonsai/docs/users/user_interface/images/ifc-project-load.png b/src/bonsai/docs/reference/images/ifc-project-load.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/ifc-project-load.png rename to src/bonsai/docs/reference/images/ifc-project-load.png diff --git a/src/bonsai/docs/users/user_interface/images/interface_property-editor_icons.png b/src/bonsai/docs/reference/images/interface_property-editor_icons.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/interface_property-editor_icons.png rename to src/bonsai/docs/reference/images/interface_property-editor_icons.png diff --git a/src/bonsai/docs/users/user_interface/images/interface_property-editor_panel-dropdown.png b/src/bonsai/docs/reference/images/interface_property-editor_panel-dropdown.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/interface_property-editor_panel-dropdown.png rename to src/bonsai/docs/reference/images/interface_property-editor_panel-dropdown.png diff --git a/src/bonsai/docs/users/user_interface/images/interface_property-editor_project-overview_start-up.png b/src/bonsai/docs/reference/images/interface_property-editor_project-overview_start-up.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/interface_property-editor_project-overview_start-up.png rename to src/bonsai/docs/reference/images/interface_property-editor_project-overview_start-up.png diff --git a/src/bonsai/docs/users/user_interface/images/interface_window_file-menue.png b/src/bonsai/docs/reference/images/interface_window_file-menue.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/interface_window_file-menue.png rename to src/bonsai/docs/reference/images/interface_window_file-menue.png diff --git a/src/bonsai/docs/users/user_interface/images/interface_window_start-up.png b/src/bonsai/docs/reference/images/interface_window_start-up.png similarity index 100% rename from src/bonsai/docs/users/user_interface/images/interface_window_start-up.png rename to src/bonsai/docs/reference/images/interface_window_start-up.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/object_information/images/interface_property-editor_object-information.png b/src/bonsai/docs/reference/object_information/images/interface_property-editor_object-information.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/object_information/images/interface_property-editor_object-information.png rename to src/bonsai/docs/reference/object_information/images/interface_property-editor_object-information.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/object_information/index.rst b/src/bonsai/docs/reference/object_information/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/object_information/index.rst rename to src/bonsai/docs/reference/object_information/index.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/advanced-mode-settings.png b/src/bonsai/docs/reference/project_overview/images/advanced-mode-settings.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/advanced-mode-settings.png rename to src/bonsai/docs/reference/project_overview/images/advanced-mode-settings.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/advanced-mode.png b/src/bonsai/docs/reference/project_overview/images/advanced-mode.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/advanced-mode.png rename to src/bonsai/docs/reference/project_overview/images/advanced-mode.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview.png b/src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview.png rename to src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_edit-header.png b/src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_edit-header.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_edit-header.png rename to src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_edit-header.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_new_load.png b/src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_new_load.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_new_load.png rename to src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_new_load.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_saved.png b/src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_saved.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_saved.png rename to src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_saved.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_unsaved.png b/src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_unsaved.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/images/interface_property-editor_project-overview_unsaved.png rename to src/bonsai/docs/reference/project_overview/images/interface_property-editor_project-overview_unsaved.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/index.rst b/src/bonsai/docs/reference/project_overview/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/index.rst rename to src/bonsai/docs/reference/project_overview/index.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/project_info.rst b/src/bonsai/docs/reference/project_overview/project_info.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/project_info.rst rename to src/bonsai/docs/reference/project_overview/project_info.rst diff --git a/src/bonsai/docs/users/user_interface/property-editor.rst b/src/bonsai/docs/reference/properties.rst similarity index 65% rename from src/bonsai/docs/users/user_interface/property-editor.rst rename to src/bonsai/docs/reference/properties.rst index 68626043a5..51f0ab1d18 100644 --- a/src/bonsai/docs/users/user_interface/property-editor.rst +++ b/src/bonsai/docs/reference/properties.rst @@ -1,5 +1,5 @@ -Property Editor Scene Properties -================================ +Properties +========== .. container:: location-scene @@ -47,14 +47,14 @@ You can also select the needed panel via the drop-down menue. :maxdepth: 1 :caption: Contents: - property_editor/scene_editor/project_overview/index - property_editor/scene_editor/object_information/index - property_editor/scene_editor/geometry_and_materials/index - property_editor/scene_editor/drawings_and_documents/index - property_editor/scene_editor/services_and_systems/index - property_editor/scene_editor/structural_analysis/index - property_editor/scene_editor/costing_and_scheduling/index - property_editor/scene_editor/facility_management/index - property_editor/scene_editor/quality_and_coordination/index - property_editor/scene_editor/blender - property_editor/scene_editor/switch_tab + project_overview/index + object_information/index + geometry_and_materials/index + drawings_and_documents/index + services_and_systems/index + structural_analysis/index + costing_and_scheduling/index + facility_management/index + quality_and_coordination/index + blender + switch_tab diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/quality_and_coordination/images/interface_property-editor_quality-coordination.png b/src/bonsai/docs/reference/quality_and_coordination/images/interface_property-editor_quality-coordination.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/quality_and_coordination/images/interface_property-editor_quality-coordination.png rename to src/bonsai/docs/reference/quality_and_coordination/images/interface_property-editor_quality-coordination.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/quality_and_coordination/index.rst b/src/bonsai/docs/reference/quality_and_coordination/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/quality_and_coordination/index.rst rename to src/bonsai/docs/reference/quality_and_coordination/index.rst diff --git a/src/bonsai/docs/blenderbim/scene.rst b/src/bonsai/docs/reference/scene.rst similarity index 100% rename from src/bonsai/docs/blenderbim/scene.rst rename to src/bonsai/docs/reference/scene.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/services_and_systems/images/interface_property-editor_services-systems.png b/src/bonsai/docs/reference/services_and_systems/images/interface_property-editor_services-systems.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/services_and_systems/images/interface_property-editor_services-systems.png rename to src/bonsai/docs/reference/services_and_systems/images/interface_property-editor_services-systems.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/services_and_systems/index.rst b/src/bonsai/docs/reference/services_and_systems/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/services_and_systems/index.rst rename to src/bonsai/docs/reference/services_and_systems/index.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/structural_analysis/images/interface_property-editor_structural-analysis.png b/src/bonsai/docs/reference/structural_analysis/images/interface_property-editor_structural-analysis.png similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/structural_analysis/images/interface_property-editor_structural-analysis.png rename to src/bonsai/docs/reference/structural_analysis/images/interface_property-editor_structural-analysis.png diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/structural_analysis/index.rst b/src/bonsai/docs/reference/structural_analysis/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/structural_analysis/index.rst rename to src/bonsai/docs/reference/structural_analysis/index.rst diff --git a/src/bonsai/docs/users/user_interface/property_editor/scene_editor/switch_tab.rst b/src/bonsai/docs/reference/switch_tab.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/property_editor/scene_editor/switch_tab.rst rename to src/bonsai/docs/reference/switch_tab.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/annotation.rst b/src/bonsai/docs/reference/toolbar/annotation.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/annotation.rst rename to src/bonsai/docs/reference/toolbar/annotation.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/beam.rst b/src/bonsai/docs/reference/toolbar/beam.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/beam.rst rename to src/bonsai/docs/reference/toolbar/beam.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/column.rst b/src/bonsai/docs/reference/toolbar/column.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/column.rst rename to src/bonsai/docs/reference/toolbar/column.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/covering.rst b/src/bonsai/docs/reference/toolbar/covering.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/covering.rst rename to src/bonsai/docs/reference/toolbar/covering.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/door.rst b/src/bonsai/docs/reference/toolbar/door.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/door.rst rename to src/bonsai/docs/reference/toolbar/door.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/duct.rst b/src/bonsai/docs/reference/toolbar/duct.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/duct.rst rename to src/bonsai/docs/reference/toolbar/duct.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/element.rst b/src/bonsai/docs/reference/toolbar/element.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/element.rst rename to src/bonsai/docs/reference/toolbar/element.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/explore.rst b/src/bonsai/docs/reference/toolbar/explore.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/explore.rst rename to src/bonsai/docs/reference/toolbar/explore.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/images/property-editor_create-wall.png b/src/bonsai/docs/reference/toolbar/images/property-editor_create-wall.png similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/images/property-editor_create-wall.png rename to src/bonsai/docs/reference/toolbar/images/property-editor_create-wall.png diff --git a/src/bonsai/docs/users/user_interface/toolbar/images/property-editor_explore-tool.png b/src/bonsai/docs/reference/toolbar/images/property-editor_explore-tool.png similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/images/property-editor_explore-tool.png rename to src/bonsai/docs/reference/toolbar/images/property-editor_explore-tool.png diff --git a/src/bonsai/docs/users/user_interface/toolbar/images/toolbar_create-wall.png b/src/bonsai/docs/reference/toolbar/images/toolbar_create-wall.png similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/images/toolbar_create-wall.png rename to src/bonsai/docs/reference/toolbar/images/toolbar_create-wall.png diff --git a/src/bonsai/docs/users/user_interface/toolbar/images/toolbar_explore-tool.png b/src/bonsai/docs/reference/toolbar/images/toolbar_explore-tool.png similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/images/toolbar_explore-tool.png rename to src/bonsai/docs/reference/toolbar/images/toolbar_explore-tool.png diff --git a/src/bonsai/docs/users/user_interface/toolbar/images/toolbar_shortcut-menu.png b/src/bonsai/docs/reference/toolbar/images/toolbar_shortcut-menu.png similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/images/toolbar_shortcut-menu.png rename to src/bonsai/docs/reference/toolbar/images/toolbar_shortcut-menu.png diff --git a/src/bonsai/docs/users/user_interface/toolbar/images/toolbar_tool-settings-access.png b/src/bonsai/docs/reference/toolbar/images/toolbar_tool-settings-access.png similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/images/toolbar_tool-settings-access.png rename to src/bonsai/docs/reference/toolbar/images/toolbar_tool-settings-access.png diff --git a/src/bonsai/docs/users/user_interface/toolbar/index.rst b/src/bonsai/docs/reference/toolbar/index.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/index.rst rename to src/bonsai/docs/reference/toolbar/index.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/slab.rst b/src/bonsai/docs/reference/toolbar/slab.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/slab.rst rename to src/bonsai/docs/reference/toolbar/slab.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/spatial.rst b/src/bonsai/docs/reference/toolbar/spatial.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/spatial.rst rename to src/bonsai/docs/reference/toolbar/spatial.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/structural.rst b/src/bonsai/docs/reference/toolbar/structural.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/structural.rst rename to src/bonsai/docs/reference/toolbar/structural.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/wall.rst b/src/bonsai/docs/reference/toolbar/wall.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/wall.rst rename to src/bonsai/docs/reference/toolbar/wall.rst diff --git a/src/bonsai/docs/users/user_interface/toolbar/window.rst b/src/bonsai/docs/reference/toolbar/window.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/toolbar/window.rst rename to src/bonsai/docs/reference/toolbar/window.rst diff --git a/src/bonsai/docs/users/user_interface/topbar.rst b/src/bonsai/docs/reference/topbar.rst similarity index 100% rename from src/bonsai/docs/users/user_interface/topbar.rst rename to src/bonsai/docs/reference/topbar.rst diff --git a/src/bonsai/docs/users/user_interface/workspace.rst b/src/bonsai/docs/reference/workspace.rst similarity index 97% rename from src/bonsai/docs/users/user_interface/workspace.rst rename to src/bonsai/docs/reference/workspace.rst index 948aebcb53..db702f4efd 100644 --- a/src/bonsai/docs/users/user_interface/workspace.rst +++ b/src/bonsai/docs/reference/workspace.rst @@ -1,5 +1,5 @@ -BIM Workspace -============= +Workspace +========= For general informations about the Blender Workspaces see the respective `Workspaces `__ section in Blender documentation. diff --git a/src/bonsai/docs/users/tutorials/files/project0-openings.ifc b/src/bonsai/docs/tutorials/files/project0-openings.ifc similarity index 100% rename from src/bonsai/docs/users/tutorials/files/project0-openings.ifc rename to src/bonsai/docs/tutorials/files/project0-openings.ifc diff --git a/src/bonsai/docs/users/tutorials/files/project0-walls.ifc b/src/bonsai/docs/tutorials/files/project0-walls.ifc similarity index 100% rename from src/bonsai/docs/users/tutorials/files/project0-walls.ifc rename to src/bonsai/docs/tutorials/files/project0-walls.ifc diff --git a/src/bonsai/docs/users/tutorials/images/project0-openings.png b/src/bonsai/docs/tutorials/images/project0-openings.png similarity index 100% rename from src/bonsai/docs/users/tutorials/images/project0-openings.png rename to src/bonsai/docs/tutorials/images/project0-openings.png diff --git a/src/bonsai/docs/users/tutorials/images/project0-walls.png b/src/bonsai/docs/tutorials/images/project0-walls.png similarity index 100% rename from src/bonsai/docs/users/tutorials/images/project0-walls.png rename to src/bonsai/docs/tutorials/images/project0-walls.png diff --git a/src/bonsai/docs/users/tutorials/images/project0.png b/src/bonsai/docs/tutorials/images/project0.png similarity index 100% rename from src/bonsai/docs/users/tutorials/images/project0.png rename to src/bonsai/docs/tutorials/images/project0.png diff --git a/src/bonsai/docs/users/tutorials/project0.rst b/src/bonsai/docs/tutorials/project0.rst similarity index 100% rename from src/bonsai/docs/users/tutorials/project0.rst rename to src/bonsai/docs/tutorials/project0.rst diff --git a/src/bonsai/docs/users/tutorials/project1.rst b/src/bonsai/docs/tutorials/project1.rst similarity index 100% rename from src/bonsai/docs/users/tutorials/project1.rst rename to src/bonsai/docs/tutorials/project1.rst diff --git a/src/bonsai/docs/users/tutorials/project2.rst b/src/bonsai/docs/tutorials/project2.rst similarity index 100% rename from src/bonsai/docs/users/tutorials/project2.rst rename to src/bonsai/docs/tutorials/project2.rst diff --git a/src/bonsai/docs/users/tutorials/project3.rst b/src/bonsai/docs/tutorials/project3.rst similarity index 100% rename from src/bonsai/docs/users/tutorials/project3.rst rename to src/bonsai/docs/tutorials/project3.rst diff --git a/src/bonsai/docs/users/tutorials/project4.rst b/src/bonsai/docs/tutorials/project4.rst similarity index 100% rename from src/bonsai/docs/users/tutorials/project4.rst rename to src/bonsai/docs/tutorials/project4.rst diff --git a/src/bonsai/docs/users/tutorials/project5.rst b/src/bonsai/docs/tutorials/project5.rst similarity index 100% rename from src/bonsai/docs/users/tutorials/project5.rst rename to src/bonsai/docs/tutorials/project5.rst diff --git a/src/bonsai/docs/users/advanced/index.rst b/src/bonsai/docs/users/advanced/index.rst deleted file mode 100644 index 47ad948228..0000000000 --- a/src/bonsai/docs/users/advanced/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -Advanced Use Cases -================== - -Advanced topics and large-scale modeling. - -.. toctree:: - :maxdepth: 1 - - georeferencing - dealing_with_large_models \ No newline at end of file diff --git a/src/bonsai/docs/users/modeling/advanced_modeling/index.rst b/src/bonsai/docs/users/modeling/advanced_modeling/index.rst deleted file mode 100644 index a43b15a339..0000000000 --- a/src/bonsai/docs/users/modeling/advanced_modeling/index.rst +++ /dev/null @@ -1,51 +0,0 @@ -============================ -Advanded Modeling Techniques -============================ - -Complex modeling techniques for advanced users. - -.. note:: - This page is a stub. More detailed content will be added in future updates. - -Custom Parametric Wall Types ----------------------------- - -[Content about creating custom parametric wall types] - -Material assignment -------------------- - -:doc:`material_assignment` - -Modeling Furniture and Fixtures -------------------------------- - -[Content about modeling furniture and fixtures] - -Structural Elements -------------------- - -.. seealso:: - - :doc:`/users/structural_analysis/index` - -[Content about modeling structural elements] - -Multi-Story Buildings ---------------------- - -[Content about modeling multi-story buildings] - -Complex Structures ------------------- - -[Content about modeling complex structures] - - - .. toctree:: - :hidden: - :caption: Sections - :maxdepth: 2 - - material_assignment - parametric_geometry \ No newline at end of file diff --git a/src/bonsai/docs/users/modeling/basic_modeling/index.rst b/src/bonsai/docs/users/modeling/basic_modeling/index.rst deleted file mode 100644 index a032b3ff97..0000000000 --- a/src/bonsai/docs/users/modeling/basic_modeling/index.rst +++ /dev/null @@ -1,44 +0,0 @@ -========================= -Basic Modeling Techniques -========================= - -Fundamental techniques for IFC modeling. - -.. only:: builder_html and (not singlehtml) - - .. container:: toc-cards - - .. container:: card - - :doc:`creating_walls` - Learn how to create and modify walls in your IFC model. - - .. container:: card - - :doc:`openings/index` - Techniques for adding and customizing doors, windows and other openings. - - .. container:: card - - :doc:`modeling_slabs_roofs` - Guide to modeling slabs and different types of roofs. - - .. container:: card - - :doc:`defining_rooms_spaces` - Methods for defining and managing rooms and spaces in your model. - -.. container:: global-index-toc - - .. toctree:: - :hidden: - :caption: Basic Modeling Techniques - :maxdepth: 1 - - creating_walls - openings/index - modeling_slabs_roofs - defining_rooms_spaces - - - diff --git a/src/bonsai/docs/users/modeling/basic_modeling/openings/index.rst b/src/bonsai/docs/users/modeling/basic_modeling/openings/index.rst deleted file mode 100644 index ee5bd9122c..0000000000 --- a/src/bonsai/docs/users/modeling/basic_modeling/openings/index.rst +++ /dev/null @@ -1,66 +0,0 @@ -Openings -======== - -This section covers the creation and management of openings in Bonsai. -Openings are crucial elements in building design, serving various purposes such as passage, ventilation, and lighting. - -.. only:: builder_html and (not singlehtml) - - .. container:: toc-cards - - .. container:: card - - :doc:`door` - Learn how to add and customize doors in your BIM model. - - .. container:: card - - :doc:`window` - Discover the process of creating and modifying windows. - - .. container:: card - - :doc:`opening` - Create openings without fillings for special architectural features. - -Overview --------- - -In the context of Building Information Modeling (BIM) and the Industry Foundation Classes (IFC) -standard, openings are represented through a combination of elements: - -1. Voids: Represented by IfcOpeningElement, these are the actual cut-outs in the wall. -2. Fillings: These are the elements that occupy the voids, such as doors (IfcDoor) or windows (IfcWindow). -3. Relationships: These are abstract objects that connect fillings to voids and voids to elements in which they're created. - -Bonsai provides tools to create and manage these elements: - -- Door Creation Tool: For adding doors to walls. -- Window Creation Tool: For adding windows to walls. -- Wall Creation Tool > Void Application: For creating openings without fillings - (currently achieved by creating a door or window and removing it - or by using "Add Void" feature of the Create Wall tool or any element). - -These tools allow you to: - -- Create openings with precise dimensions and positions. -- Modify opening properties and geometries. -- Manage the relationships between walls, voids, and fillings. - -The following pages provide detailed guides on working with each type of wall opening in Bonsai. - -.. container:: global-index-toc - - .. toctree:: - :hidden: - :caption: Wall Openings - :maxdepth: 1 - - door - window - opening - -See Also --------- - -- :doc:`../creating_walls` diff --git a/src/bonsai/docs/users/modeling/importing_viewing_models.rst b/src/bonsai/docs/users/modeling/importing_viewing_models.rst deleted file mode 100644 index 3f71e74432..0000000000 --- a/src/bonsai/docs/users/modeling/importing_viewing_models.rst +++ /dev/null @@ -1,4 +0,0 @@ -Importing and Viewing IFC Models -================================ - -[Content about importing and viewing IFC models] diff --git a/src/bonsai/docs/users/modeling/interface.rst b/src/bonsai/docs/users/modeling/interface.rst deleted file mode 100644 index 1905f941ec..0000000000 --- a/src/bonsai/docs/users/modeling/interface.rst +++ /dev/null @@ -1,92 +0,0 @@ -============================ -Bonsai Interface Guide -============================ - -Introduction -============ - -Bonsai's interface extends Blender's powerful 3D environment with specialized tools for Building Information Modeling (BIM). This guide will help you navigate the Bonsai interface and understand its key components. - -Bonsai Workspace -================ - -When you start Blender with Bonsai installed, you can switch to the Bonsai workspace -by clicking on the BIM workspace tab at the top of the Blender window. - -This workspace is preconfigured with the most commonly used panels and tools for BIM workflows. - - -Key Interface Elements -====================== - -Properties Extended -------------------- - -The Properties Editor is extended to provide IFC-specific properties and settings. - -- Scene - - Project Information -- Tool -- Object - -BIM Toolbar ------------ - -The BIM toolbar, typically located at the left of the 3D Viewport, contains shortcuts to frequently used BIM tools: - -- Explore tool -- Create various building elements -- Create annotations, measure distance and angles, calculate volumes, etc - - -IFC Tree View -------------- - -Found in the Outliner, the IFC Tree View displays the hierarchical structure of your BIM model: - -- Spatial Structure (Site, Building, Storey) -- Building Elements -- Types - -Customizing the Interface -========================= - -Bonsai respects Blender's highly customizable interface. You can: - -- Rearrange editors and panels -- Save custom workspace layouts -- Create custom shortcuts for BIM operations - -Tips for Efficient Use -====================== - -1. Familiarize yourself with IFC classes and their properties. -2. Utilize Blender's search function (F3) to quickly access Bonsai tools. - - -Next Steps -========== - -Now that you're familiar with the Bonsai interface, you have two main paths to continue your learning: - -1. Proceed with IFC Modeling: - If you're ready to start creating and working with BIM models, you can move on to: - - - :doc:`IFC Modeling Basics ` - -2. Dive deeper into the User Interface: - If you want to explore more details about the Bonsai interface, you can refer to: - - - :doc:`User Interface Reference ` - -Choose the path that best suits your current needs and learning style. You can always come back to explore the other option later. - -Remember, as you become more comfortable with the interface and basic modeling, you can explore more advanced topics such as: - -- :doc:`Generating Documentation ` -- :doc:`Advanced BIM Techniques ` - -The Bonsai interface is designed to integrate seamlessly with Blender while providing powerful BIM-specific functionality. -As you progress, you'll find your BIM workflow becoming increasingly efficient and productive. - - diff --git a/src/bonsai/docs/users/tutorials/index.rst b/src/bonsai/docs/users/tutorials/index.rst deleted file mode 100644 index 4bf6a87155..0000000000 --- a/src/bonsai/docs/users/tutorials/index.rst +++ /dev/null @@ -1,98 +0,0 @@ -======================= -Tutorials -======================= - -Project Series -============== - -Step-by-step guides for real-world BIM projects. - -.. toctree:: - :maxdepth: 2 - :hidden: - - project0 - project1 - project2 - project3 - project4 - project5 - -.. only:: builder_html and (not singlehtml) - - .. container:: toc-cards - - .. container:: card - - :doc:`Project 0: Designing a Room ` - * Basic walls and openings - * Slabs - * MEP - * Basic furniture - * Basic floor plan drawings - - .. container:: card - - :doc:`Project 1: Designing a Flat ` - * Advanced walls and openings - * Profiles - * Rooms and spaces - * Furniture/fixture libraries - * Elevation/section drawings - - .. container:: card - - :doc:`Project 2: Building a Bungalow ` - * Roof - * Advanced foundation - * Structural elements - * Roof openings - * Underground services - * Running services in subfloor space - * Drawing details - * Basic costing and scheduling - - .. container:: card - - :doc:`Project 3: Multi-Storey Single-Family Home ` - * Templating - * Types - * Complex roofs - * Complex fixtures (e.g. solar panels) - * Complex HVAC, plumbing, electrical - * Basic site landscaping - - .. container:: card - - :doc:`Project 4: Terraced/Town Houses/Duplexes ` - * Shared walls - * Shared roofs - * Complex landscaping - * Duplicating units - * Basic parametric floor plans - * Generating drawings parametrically - * Clash detection - * Coordination with other stakeholders - - .. container:: card - - :doc:`Project 5: Apartment Block ` - * Multiple levels - * Typical floor - * Shared amenities and common areas - * Elevators - * Parametric services - * Complex structural elements - * Advanced exporting - * Merging - * Coordination - * Analysis - * Advanced costing and scheduling - * External tools - -Quickstart Video Tutorial -========================= - -Learn how to model a small building and create simple architectural plans, sections, 2D details, and sheet layouts in this short tutorial series. - -`View all tutorial videos `__ diff --git a/src/bonsai/docs/users/user_interface.rst b/src/bonsai/docs/users/user_interface.rst deleted file mode 100644 index 82c1fbcbc8..0000000000 --- a/src/bonsai/docs/users/user_interface.rst +++ /dev/null @@ -1,23 +0,0 @@ -User Interface Reference -======================== - -This section covers the general user interface of Bonsai. User interface documentation does not cover any specific use case but provides a general reference of Bonsai UI. - -The documentation doesn't cover Blender UI, but makes references to `Blender documentation `__ where appropriate. - -.. * Navigating the Project Browser and Outliner -.. * Using the Property Panels -.. * Toolbars and Menus -.. * Customizing the Interface -.. * Keyboard Shortcuts and Preferences - -.. toctree:: - :hidden: - :maxdepth: 1 - :caption: Contents: - - user_interface/topbar - user_interface/workspace - user_interface/toolbar/index - user_interface/property-editor -