Knowledgebase

Everything "meta" about this project.

Where we work¶

The most important documents are the documentation "templates", which are crucial to organize:

A detailed explanation of how we develop towards documentation is available over here.

Note

Over the years I have learnt to greet friendly open source developers with a warm "where are the docs?" salute. Eveyone loves it.

Our part numbering schema available here

A detailed explanation of our part labeling method is available here

Parts: [Versioned Part ID] = [Part ID (part number)] + [revision number]
Assemblies: [Versioned Assembly ID] = [Assembly ID (Assembly number)] + [revision number]

When can part names change?

The revision number is only modified when a "slight" modification is made to a part or assembly; this mean that the modification does not make it incompatible with the parts or assemblies it originally interacted with.
Part/Assembly IDs are incremented only when the modification on the part or assembly introduces an incompatibility with the parts or assemblies it originally interacted with.

Inspired by Jubilee's schema available here

We use a common TechDraw template for the project's drawings: TechDraw Template

There are several parameters in TechDraw which can be adjusted:

Line thickness 0.7 (Line width group).
Show hidden edges as dotted lines (Hidden line style).
To activate the visualization you have to access manually (blue: Hard hidden).
Some useful tools:
Hide edges (yellow: Hide edges): With this tool we can remove edges that have remained on the bodies, resulting from revolutions, etc.
Print view (green: Print view): with this tool we can 'hide' all the annoying extra objects to have a clearer vision, without the need to export as pdf, as shown in the third image.