Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 640 Bytes

service-template.md

File metadata and controls

39 lines (24 loc) · 640 Bytes

Template

This is the template for service documentation. Start with a brief description of what the service does.

Config

Provide a sample config:

services:
  - type: kebab-case
    ...

Then explain what each block or key does.

Examples

Provide a few examples of common uses and the expected response.

input: this is a test

reply: response: test

Usage

Provide detailed usage instructions for each feature of the service.

Command

cmd [arg] [...options]

Start with the arguments, then elaborate on each command.

Interactions

Any notes about interactions with other services.