Skip to main content
Version: 2.4

Bricks Documentation

What is a brick documentation?

Any brick you produce is as good and useful, as clear & detailed its documentation is.

Note that a brick does not have to be shared or public to justify the effort to be documented. Any user including its own author will find value in such documentation for productivity and maintenance purposes.

For that matter, the Spec & Doc tab allows the creation of any brick's documentation, where, the Description & Summary are defined, along with the documentation for all inputs & ouputs in case of an Action or a Function.

Example of a user facing brick documentation


Source version of this brick documentation

Desription & Summary as defined in the Spec & Doc tab.

Source text for the input values.