Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-09-20 06:58:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix #2600. Link back to exact docs folder in repo.

Browse Source
This commit is contained in:
Dion Moult
2023-02-24 16:21:21 +11:00
parent aa172488b0
commit f2c03a508f
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/blenderbim/docs/devs/writing_docs.rst
+12
View File
@@ -1,6 +1,18 @@
Writing docs Writing docs
============ ============
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>`_.
The following colours and annotation styles should be used for annotating The following colours and annotation styles should be used for annotating
images. All stroke widths are 3px with a corner radius of 3px. Horizontal images. All stroke widths are 3px with a corner radius of 3px. Horizontal
underlines are 5px with a corner radius of 2px. The dark green is **39b54a** and underlines are 5px with a corner radius of 2px. The dark green is **39b54a** and