<project>¶

You can add a small introduction to the <extension-key>. If you are new to writing a documentation in general this section provides a good starting point to look at.

Provide which steps should be done to install the <extension-key> properly. We recommend to give enough hints to kindly guide the user through this process.

In this section you should cover all the needed configurations to set up the <extension-key> correctly. Additionally you should present an overview about all available configurations one can set up in <extension-key>.

In this section you can describe how a user can use its custom templates. Additionally you can present and describe what your custom viewhelpers are doing. Last but not least you can provide some example templates.

This section is specialised for editors. Editors find everything that is useful for them using the <extension-key> in this section.

Use this section to provide examples of code or any information that would be deemed relevant to a developer. For example explain how a certain feature was implemented.

Use this section for informing about troubleshooting. If the users of your extension encountered any problems they should be able to find information to solve their problems in this section.