The Docs

Where and how to get the documentation.

Every Mjolnir project and module comes with the documentation built-in. We do not provide auto-generated source code documentation (though the source code is documented) but actual hand written documentation; and we have our documentation as an integral part of our process.

On any mjolnir based project you may generate a html and pdf version of the documentation by running ./order librarian --manual on the project's root. You may also view the documentation directly, which is located typically in +Docs folders under each module in the form of readable markdown files.

We recomend viewing documentation generated inside the project because it may include information provided by 3rd party modules.


based on the default modules