Skip to content

Contribute to Kleene's docs

Keeping documentation up to date, easy to understand and with lots of insightful/helpful examples is a huge task - and there is always more that could be done. If you want to help out that is greatly appreciated!

The documentation site is built with MkDocs using the Material for MkDocs theme.

Style

Naming, voice and markup conventions for Kleene's documentation are collected in the style guide. Read it before writing or reviewing documentation pages - it defines how Kleene, Klee and Kleened are used, how network drivers such as ipnet and vnet are written, and how commands and output are formatted.

For further reading, Docker's style guide and checklist are useful references for general documentation writing, even though Kleene's conventions differ in places.