Skip to content

User guide

Welcome to the PROJECTNAME User guide!

If your project is not going to have a docsite (for example, if it is very simple to use), the following information should be present in your project README as in the README template.

In the following sections, if the content is as simple as a few lines, put it in there, otherwise create separate files and refer to them from the sections.

Communication

Need help or want to share feedback? See the Community guide!

Getting started

Describe how to get started here or refer to a separate Getting started guide.

Installation

Describe possible installation options for popular platforms here or refer to a separate installation guide.

Next section

Add as many sections as needed to cover all usage aspects.

It is also encouraged to cover common use cases with how-to guides and list them here.