Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.05 KB

_template.md

File metadata and controls

37 lines (29 loc) · 1.05 KB

TOPIC NAME

One or two sentences: what the tool or topic is and when to use it. Link related sheets with relative Markdown links, e.g. Docker and Docker Compose.

Project: PROJECT NAME Documentation: DOCS NAME

Basics

COMMAND DESCRIPTION
tool command <ARGUMENT> What it does, in a short phrase
tool command --flag <VALUE> What the flag changes
tool a / tool b Paired commands share a row

Common Tasks

Explain a multi-step task in one sentence, then show it as a fenced block with a language tag.

tool init PROJECT_NAME
tool run --config CONFIG_FILE

Configuration

Show a minimal, working config. Use ALL-CAPS placeholders for anything the reader must replace.

name: EXAMPLE_NAME
host: HOSTNAME
token: API_TOKEN

Troubleshooting

SYMPTOM FIX
Short description of the error What to check or run

See Also

  • Docker (replace with a real sheet; every link must resolve)