Page templates¶

Each Diátaxis type has a template in the repository's templates/ folder. Start new pages with make new, which copies the right template into the right folder and fills in the domain and date:

make new TYPE=tutorial    DOMAIN=network-security SLUG=first-nftables-firewall
make new TYPE=how-to      DOMAIN=storage          SLUG=extend-lvm-volume
make new TYPE=reference   DOMAIN=boot-init        SLUG=systemd-unit-directives
make new TYPE=explanation DOMAIN=storage          SLUG=linux-storage-stack

Structure by type¶

Type	Sections
Tutorial	What you will build · Before you begin (exact environment and lab) · Step 1…N (action, expected output, what to notice) · What you have learned · Next steps
How-to guide	Before you begin · Steps (distribution tabs where they differ) · Verify · Troubleshooting · Related
Reference	Synopsis · Description · Options or fields · Examples · Files · See also
Explanation	Context · How it works · Design decisions and trade-offs · Alternatives · Further reading

Each template starts with a comment summarising the rules for its type. Delete the comment and every TODO before opening a PR or MR.