Area template

Copy this folder to start a new area of work.

Area template

This folder is the shape every area takes. Copy it, rename it, edit these two files. Nothing else is required — the sidebar and the entry point both pick it up automatically.

docs/be-<category>-<name>/
├── meta.ts     the sidebar label and order
└── index.md    what this area is for

Naming

   be  -  category  -  name
   │         │           │
   │         │           └── which one
   │         └────────────── what kind of area it is
   └──────────────────────── ours

Flat, one level under docs/. Never nest an area inside another area — see Architecture.

meta.ts

import { defineMeta } from "blume";
export default defineMeta({ title: "Human name", order: 2, pages: ["index"] });

order: 1 is taken by How to fly. Use 2 or higher. pages lists slugs in sidebar order — a file name minus any numeric prefix.

index.md

Frontmatter needs title and description. Quote any description containing a colon — an unquoted colon is invalid YAML and fails the build.

Then say what the area is for and what decisions live in it. Keep it under 500 words; npm run validate enforces that.

What happens when you add it

  mkdir docs/be-<category>-<name>/
        │
        ├─▶ sidebar group appears on the next build
        └─▶ be-<category>-<name> becomes a shell command
                                  (the ~/.zshrc loop globs docs/be-*)

No registry to update, no routing config. That is the point of flat — see the entry point.