A template for creating documentation for features. Examples BringMe or the Mouse in the ReadTheDocs.
- Very short command description:
<target> in code [<form>]
- Describe the variables here and add further explanation for this command.
<target>is a variable that needs an explanation, for example.
<target>might be sauce or dunce. Refer to variables, e.g.
backticksand refer to spoken phrases using italics.
- sauce in code
- If not obvious what the example does, add a description here.
- sauce in code form
- Try to cover a lot of different possible examples as lots of people learn this way before reading the proper documentation.