Overview

    If you make code contributions that change the behavior of Vaadin products, the new behavior always needs to be documented. Documentation should be done along with any such feature additions or changes. Hence, if you develop any features for the Vaadin products, you need to be familiar with the documentation tools and processes.

    Editing Tools

    Gives instructions for editing and previewing documentation. The easiest way is to edit GitHub, but it has limitations. You can use any editor, but some support highlighting and previewing. You can also do preview with various external tools.

    Formatting with AsciiDoc

    Vaadin documentation is currently written in the AsciiDoc format. We follow certain special conventions of using AsciiDoc. This document gives introduction to basic document structure and format. Emphasis should be done with special style names, and so forth.

    Gives style guidelines for formatting and the use of English language in various special cases.

    Explains how documentation should be done as part of the software development process.

    Source code for Vaadin products is available from GitHub at . Its ticket system is the primary way to file bug reports and make feature requests.

    AsciiDoc Resources