2022-05-07 11:42:12 +10:00
|
|
|
Writing docs
|
|
|
|
|
============
|
|
|
|
|
|
2023-02-24 16:21:21 +11:00
|
|
|
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
|
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
|
|
All documentation is written in ReStructured Text and is available in the
|
|
|
|
|
`BlenderBIM Add-on docs directory
|
|
|
|
|
<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.7.0/src/blenderbim/docs>`_.
|
|
|
|
|
|
2022-05-07 11:42:12 +10:00
|
|
|
The following colours and annotation styles should be used for annotating
|
2022-08-27 10:36:54 -04:00
|
|
|
images. All stroke widths are 3px with a corner radius of 3px. Horizontal
|
2022-05-07 11:42:12 +10:00
|
|
|
underlines are 5px with a corner radius of 2px. The dark green is **39b54a** and
|
|
|
|
|
the light green is **d9e021**.
|
|
|
|
|
|
|
|
|
|
.. image:: documentation-style.png
|
