Improve docs (#7005)

This commit is contained in:
Christoph Mellüh
2025-08-18 08:14:06 +02:00
committed by GitHub
parent aa97cc25d1
commit f9dc7d5d94
194 changed files with 388 additions and 138 deletions
+63
View File
@@ -0,0 +1,63 @@
Tutorials and Real-World Projects
=================================
This chapter covers multiple real-World Projects
.. only:: builder_html and (not singlehtml)
.. container:: toc-cards
.. container:: card
:doc:`project0`
In this introductory project, you'll learn the basics of using Bonsai to design a simple room.
By the end of this tutorial, you'll have created a basic 3D model and a 2D floor plan drawing.
.. container:: card
:doc:`project1`
Building on the skills from Project 0, this tutorial will guide you through designing a complete flat using Bonsai.
You'll learn more advanced techniques for creating walls and openings, working with profiles, defining rooms and spaces,
and generating more detailed drawings.
.. container:: card
:doc:`project2`
In this project, we'll take your Bonsai skills to the next level by designing a complete bungalow.
You'll learn about roof design, advanced foundations, structural elements, and more complex MEP systems.
We'll also introduce basic costing and scheduling concepts.
.. container:: card
:doc:`project3`
In this project, we'll design a multi-storey single-family home using Bonsai.
This tutorial will introduce more advanced concepts such as templating, complex roofs, and sophisticated MEP systems.
We'll also touch on basic site landscaping.
.. container:: card
:doc:`project4`
In this project, we'll design a row of terraced houses, town houses, or duplexes using Bonsai.
This tutorial will introduce concepts such as shared walls, duplicating units, parametric design,
and collaboration with other stakeholders.
.. container:: card
:doc:`project5`
In this final project, we'll design a complex apartment block using Bonsai.
This tutorial will introduce advanced concepts such as multi-level design, vertical transportation, parametric services,
complex structural elements, and advanced project management techniques.
.. toctree::
:maxdepth: 1
project0
project1
project2
project3
project4
project5
+3 -3
View File
@@ -37,7 +37,7 @@ Tutorial Steps
3. Save it as `project0.ifc` file.
4. (optional) Save the `project0.blend` file.
.. note:: See :doc:`/users/modeling/starting_new_project` for detailed instructions.
.. note:: See :doc:`/guides/authoring/starting_new_project` for detailed instructions.
2. Creating Walls
-----------------
@@ -56,7 +56,7 @@ Tutorial Steps
6. Use a Measure tool to ensure proper dimensions.
The interior lenghts of the walls should be 2.8m, 2.7m and 2.6m.
.. note:: Refer to :doc:`/users/modeling/basic_modeling/creating_walls` for step-by-step guidance on wall creation.
.. note:: Refer to :doc:`/guides/authoring/basic_modeling/creating_walls` for step-by-step guidance on wall creation.
If you still struggling, here's what you should get:
@@ -105,7 +105,7 @@ If you still struggling, here's what you should get:
6. Ensure that the openings do not intersect with corners or other openings.
.. note:: Refer to :doc:`/users/modeling/basic_modeling/openings/index` for detailed instructions
.. note:: Refer to :doc:`/guides/authoring/basic_modeling/opening` for detailed instructions
on creating and modifying openings, including how to create openings without fillings.
If you're having difficulties, you can download the sample file:
+3 -2
View File
@@ -26,13 +26,14 @@ Tutorial Steps
1. Project Setup
----------------
.. include:: /_incomplete_message.rst
1. Open Blender and switch to the Bonsai workspace
2. Create a new IFC project
3. Save it as `project1.ifc` file (and optionally, `project1.blend` file)
4. Load custom libraries and templates
.. note:: See :doc:`/users/modeling/starting_new_project` for detailed instructions.
.. note:: See :doc:`/guides/authoring/starting_new_project` for detailed instructions.
2. Advanced Wall Creation
-------------------------
+3 -1
View File
@@ -2,6 +2,8 @@
Project 2: Building a Bungalow
==============================
.. include:: /_incomplete_message.rst
In this project, we'll take your Bonsai skills to the next level by designing a complete bungalow.
You'll learn about roof design, advanced foundations, structural elements, and more complex MEP systems.
We'll also introduce basic costing and scheduling concepts.
@@ -34,7 +36,7 @@ Tutorial Steps
2. Define project parameters (site conditions, climate zone, etc.)
3. Create a basic site plan
.. note:: See :doc:`/users/modeling/starting_new_project` for detailed instructions.
.. note:: See :doc:`/guides/authoring/starting_new_project` for detailed instructions.
2. Advanced Foundation Design
+2
View File
@@ -2,6 +2,8 @@
Project 3: Multi-Storey Single-Family Home
==========================================
.. include:: /_incomplete_message.rst
In this project, we'll design a multi-storey single-family home using Bonsai.
This tutorial will introduce more advanced concepts such as templating, complex roofs, and sophisticated MEP systems.
We'll also touch on basic site landscaping.
+2
View File
@@ -2,6 +2,8 @@
Project 4: Terraced/Town Houses/Duplexes
========================================
.. include:: /_incomplete_message.rst
In this project, we'll design a row of terraced houses, town houses, or duplexes using Bonsai.
This tutorial will introduce concepts such as shared walls, duplicating units, parametric design,
and collaboration with other stakeholders.
+2
View File
@@ -9,6 +9,8 @@ complex structural elements, and advanced project management techniques.
Prerequisites
=============
.. include:: /_incomplete_message.rst
- Completion of Project 4: Terraced/Town Houses/Duplexes
- Expert-level understanding of Bonsai and IFC concepts
- Basic knowledge of structural and MEP engineering principles