Skip to content

Page Templates

Copy the template that matches the page you are writing. Each one follows the learning path: an Engineering Note records what was learned, and a Tutorial turns it into a guided build. A Self-Hosting Guide makes it something administrators run, and a Product Guide documents it for customers.

The source files live in templates/ at the root of the repository.

---
description: One sentence on what this note covers. Shown in search results and link previews.
tags:
  - Topic
---
# Title in Plain Words

One paragraph: what this is, and who it is for.

## Prerequisites

- What the reader needs installed or understood first.

## 1. First step

What to do, then the command:

```bash
command --flag
```

## Lessons learned

- **What surprised you.** Why it matters, and what you would do differently.

## Troubleshooting

**`exact error message`**: the cause, then the fix.

## Further reading

- [Official documentation](https://example.com)

---
description: By the end of this tutorial you will have <outcome>.
tags:
  - Tutorial
  - Topic
---
# Build <Outcome> with <Tool>

**Time:** ~30 minutes · **Level:** Beginner

By the end you will have <a working thing>. This builds on [the related note](../path/to/note.md).

## What you'll build

One short paragraph or a diagram.

## Before you start

- [ ] Requirement one
- [ ] Requirement two

## Step 1: <action>

Instructions, then the command, then what the reader should see:

```bash
command
```

```text
expected output
```

## Check your work

How to confirm it works.

## Next steps

- Where to go next, usually a Self-Hosting Guide.

---
description: Run <service> on your own server with <stack>.
tags:
  - Self-Hosting
  - Topic
---
# Self-Host <Service>

What this guide sets up, and the result: a running, secured, backed-up <service>.

!!! info "Tested with"
    <operating system> x.y · <runtime> x.y · <service> x.y

## Requirements

| Resource | Minimum |
| --- | --- |
| CPU | 1 vCPU |
| Memory | 1 GB |
| Disk | 10 GB |

## Install

## Secure

## Back up

## Update

## Monitor

## Troubleshooting

---
description: <Stage> guide for <Product>.
tags:
  - <Product>
---
# <Product>: <Installation | Configuration | Administration | Troubleshooting>

!!! abstract "Applies to"
    <Product> version x.y and later.

## Overview

What this page covers and when you need it.

## Steps

1. Step one.
2. Step two.

## Reference

| Setting | Default | Description |
| --- | --- | --- |
| `SETTING_NAME` | `value` | What it controls. |

## Related

- Link to the next stage.

Tutorials

Tutorials live beside the notes they build on, in the same Engineering Notes topic folder, and carry the Tutorial tag. Browse them all from Tags.