How-To Guide
Type
Template
Status
Published
Created
Jul 18, 2026
Updated
Jul 18, 2026

Goal#

Describe what the reader will accomplish by following this guide.

Prerequisites#

  • Prerequisite 1
  • Prerequisite 2

Steps#

Step 1: First action#

Describe what to do and why.

# Example command
example-cli do-something

Step 2: Next action#

Describe what to do and why.

Step 3: Verify the result#

Describe how to confirm the task was completed successfully.

Expected Outcome#

Describe what the reader should see or have when done.

Common Pitfalls#

  • Pitfall 1: Description and how to avoid it.
  • Pitfall 2: Description and how to avoid it.