diff --git a/src/blenderbim/docs/devs/documentation-style.png b/src/blenderbim/docs/devs/documentation-style.png new file mode 100644 index 0000000000..75f2596c62 Binary files /dev/null and b/src/blenderbim/docs/devs/documentation-style.png differ diff --git a/src/blenderbim/docs/devs/writing_docs.rst b/src/blenderbim/docs/devs/writing_docs.rst new file mode 100644 index 0000000000..279111bb3f --- /dev/null +++ b/src/blenderbim/docs/devs/writing_docs.rst @@ -0,0 +1,9 @@ +Writing docs +============ + +The following colours and annotation styles should be used for annotating +images. All stroke widths are 3px with a corner radius of 3px. Horizonal +underlines are 5px with a corner radius of 2px. The dark green is **39b54a** and +the light green is **d9e021**. + +.. image:: documentation-style.png diff --git a/src/blenderbim/docs/index.rst b/src/blenderbim/docs/index.rst index 1eb9fc0651..88e887f908 100644 --- a/src/blenderbim/docs/index.rst +++ b/src/blenderbim/docs/index.rst @@ -25,6 +25,7 @@ The BlenderBIM Add-on lets you analyse, create, and modify OpenBIM with Blender. devs/installation devs/hello_world devs/running_tests + devs/writing_docs devs/undo_system devs/ux_guidelines devs/georeferencing diff --git a/src/blenderbim/docs/users/attributes.png b/src/blenderbim/docs/users/attributes.png index 7fad33199e..1635813e4b 100644 Binary files a/src/blenderbim/docs/users/attributes.png and b/src/blenderbim/docs/users/attributes.png differ diff --git a/src/blenderbim/docs/users/blenderbim-layout.png b/src/blenderbim/docs/users/blenderbim-layout.png index 574874d3cc..3ef73d21aa 100644 Binary files a/src/blenderbim/docs/users/blenderbim-layout.png and b/src/blenderbim/docs/users/blenderbim-layout.png differ diff --git a/src/blenderbim/docs/users/element-class-select.png b/src/blenderbim/docs/users/element-class-select.png index dda36889ba..4e2304b93f 100644 Binary files a/src/blenderbim/docs/users/element-class-select.png and b/src/blenderbim/docs/users/element-class-select.png differ diff --git a/src/blenderbim/docs/users/element-class.png b/src/blenderbim/docs/users/element-class.png index cf384173fc..c38e518e2c 100644 Binary files a/src/blenderbim/docs/users/element-class.png and b/src/blenderbim/docs/users/element-class.png differ diff --git a/src/blenderbim/docs/users/example-project.png b/src/blenderbim/docs/users/example-project.png index 4686b0a294..e9816f4c55 100644 Binary files a/src/blenderbim/docs/users/example-project.png and b/src/blenderbim/docs/users/example-project.png differ diff --git a/src/blenderbim/docs/users/frame-selected.png b/src/blenderbim/docs/users/frame-selected.png index cdd1a016e7..ea297bc9a9 100644 Binary files a/src/blenderbim/docs/users/frame-selected.png and b/src/blenderbim/docs/users/frame-selected.png differ diff --git a/src/blenderbim/docs/users/install-blenderbim-1.png b/src/blenderbim/docs/users/install-blenderbim-1.png index 5cc0e419f9..79d1ef91c2 100644 Binary files a/src/blenderbim/docs/users/install-blenderbim-1.png and b/src/blenderbim/docs/users/install-blenderbim-1.png differ diff --git a/src/blenderbim/docs/users/install-blenderbim-2.png b/src/blenderbim/docs/users/install-blenderbim-2.png index 76f04b5eae..ab81f74adf 100644 Binary files a/src/blenderbim/docs/users/install-blenderbim-2.png and b/src/blenderbim/docs/users/install-blenderbim-2.png differ diff --git a/src/blenderbim/docs/users/install-blenderbim-3.png b/src/blenderbim/docs/users/install-blenderbim-3.png index fb6dda9dbf..7af37299d9 100644 Binary files a/src/blenderbim/docs/users/install-blenderbim-3.png and b/src/blenderbim/docs/users/install-blenderbim-3.png differ diff --git a/src/blenderbim/docs/users/install-blenderbim-4.png b/src/blenderbim/docs/users/install-blenderbim-4.png index a5ce351065..179613072c 100644 Binary files a/src/blenderbim/docs/users/install-blenderbim-4.png and b/src/blenderbim/docs/users/install-blenderbim-4.png differ diff --git a/src/blenderbim/docs/users/outliner-filter.png b/src/blenderbim/docs/users/outliner-filter.png index aeb2ce55a1..08cafb6632 100644 Binary files a/src/blenderbim/docs/users/outliner-filter.png and b/src/blenderbim/docs/users/outliner-filter.png differ diff --git a/src/blenderbim/docs/users/outliner-isolate.png b/src/blenderbim/docs/users/outliner-isolate.png index 320142c4ee..b63fd9cdc8 100644 Binary files a/src/blenderbim/docs/users/outliner-isolate.png and b/src/blenderbim/docs/users/outliner-isolate.png differ diff --git a/src/blenderbim/docs/users/properties-loadproject.png b/src/blenderbim/docs/users/properties-loadproject.png index 8c38af054f..88f5be2ddc 100644 Binary files a/src/blenderbim/docs/users/properties-loadproject.png and b/src/blenderbim/docs/users/properties-loadproject.png differ diff --git a/src/blenderbim/docs/users/psets.png b/src/blenderbim/docs/users/psets.png index 1e9493741c..cae396693e 100644 Binary files a/src/blenderbim/docs/users/psets.png and b/src/blenderbim/docs/users/psets.png differ diff --git a/src/blenderbim/docs/users/qtos.png b/src/blenderbim/docs/users/qtos.png index 7a7b250cf8..5746f10a83 100644 Binary files a/src/blenderbim/docs/users/qtos.png and b/src/blenderbim/docs/users/qtos.png differ diff --git a/src/blenderbim/docs/users/scene-statistics.png b/src/blenderbim/docs/users/scene-statistics.png index c1d8250049..52362f050f 100644 Binary files a/src/blenderbim/docs/users/scene-statistics.png and b/src/blenderbim/docs/users/scene-statistics.png differ diff --git a/src/blenderbim/docs/users/x-ray-mode.png b/src/blenderbim/docs/users/x-ray-mode.png index fe0649bdfe..70afad3446 100644 Binary files a/src/blenderbim/docs/users/x-ray-mode.png and b/src/blenderbim/docs/users/x-ray-mode.png differ