Handbook template

Authoring resource. Copy a template into the appropriate collection and replace its prompts.

Copy this file to docs/handbook/topic.md. Replace the id and title, set collection: handbook, and choose an unused positive sidebar_position. Replace topic with a descriptive lowercase name without a number prefix. Add the page to the index in that order. See creating a document.

Use headings that fit the subject and remove prompts or sections you do not need.

Purpose

Explain what this page helps someone understand or do, and what they need before starting.

How it works

Replace this heading with one that describes the topic. Explain the behavior or give the steps to follow. Show commands and expected results, and link useful code or configuration. Say which files or settings change and how to undo changes when needed.

Example

Give a small example the reader can try. Explain placeholders and use sample values instead of secrets. Say what you tried and what is still untested.

Problems and limits

Describe common problems and how to fix them. Point out anything that is not ready or does not work in some environments.

---

Source: docs/templates/handbook.md. Revision: 3841815ceb9e.