Documentation Policy - diirt/diirt GitHub Wiki

The overall aim is to reduce the amount of time spent writing documentation, and to decrease the chance that the documentation gets stale. We try to do this by using code/default configuration files as the main source of examples.

Guidelines

1. All user documentation shall be in the wiki. There is just one top-level README that points to the wiki.
2. API reference documentation shall be Javadocs.
3. Examples of use shall be part of the distribution. They are either actual components of diirt or files in the samples module. This guarantee that they are always at least compilable. Further explanation of the examples shall be comments in the code. Wiki pages shall link to those examples, instead of providing code directly.
4. Syntax of the configuration files, where possible, shall be in the default configuration file bundled with the corresponding module.

Minor guidelines

• Avoid using a title as the first element in the wiki page. Use the page name as the title. It wastes less space.
• Store images in the web repository (diirt.github.io/images). The Wiki pages do not allow for attachments.