howto-write-documentation.adoc

How-to write documentation

Apart from standard Javadoc comments used inside the actual source code and the README, TransportEditor has all its documentation written in the docs/ folder, using Asciidoctor markup.

To preview the changes you make, you can use one of these:

• Asciidoctor Chrome Extension

• Asciidoctor Firefox Addon

After installing, just open the file in your browser of choice.