Documentation example template

Single-line description/intro

Overview

Multi-line/paragraph description

Purpose

What is the purpose of this plugin?

Rationale

  • Why does it work the way it does?
  • Why is it necessary?
  • When should we use it?
  • When should we not use it?

Implementation

  • How does a user implement this?
  • Link to a basic working example

Parameters

Single-line introduction

First parameter

  • Description of parameter
    • Range of accepted values
    • Properties
    • When do we use this parameter
    • etc.
  • Link to a working example using the parameter

Second parameter

  • description of parameter
    • Range of accepted values
    • Properties
    • When do we use this parameter
    • etc.
  • Link to a working example using the parameter

Development

What do developers need to know?

Known issues

List any known issues with the plugin here and whether or not they will be fixed.

Future

What are the plans for this plugin?

  • Proposed changes
  • What is under development
  • etc...

Version history

  • Description
  • Link to project commit descriptions

Related pages

List related WET documentation

References

List related external pages