templates / Guide template
DocsTemplatesGuide template

Guide template

A guide helps the reader finish one task. Say who it is for and what they will have at the end. Delete every template comment before committing.

1 min readTemplates
markdown
---
title: {{title}}
description: {{description}}
type: guide
since: {{since}}
---

<!-- template: a guide helps the reader finish one task. Say who it is for and what they will have at the end. Delete every template comment before committing. -->

## Before you begin

- <requirement 1>
- <requirement 2>

## Steps

### 1. <First step>

What to do and why, then the command or action:

```bash
<command>
```

Expected result: <what the reader should see>.

### 2. <Second step>

## Verify it worked

How the reader confirms the task is done.

## Troubleshooting

| Symptom | Cause | Fix |
| --- | --- | --- |
| <what the reader sees> | <why> | <what to do> |

## Next steps

- [<Related guide>](./related.md)