Frontmatter

Frontmatter

Frontmatter is the YAML block at the top of a page, between two --- lines. Only title is required.

---
title: Installing the SDK
description: Add the client library to a Node project.
owner: ada@example.com
review_every: 90
last_reviewed: 2026-08-01
---

Identity

titlestringrequired

The page heading, the navigation label, and the <title> tag. A page without a title fails the missing-title rule.

descriptionstring

One sentence. It becomes the meta description and the card subtitle when another page links to this one.

sectionstring

The section this page belongs to, when it is not derived from the path.

groupstring

A grouping label inside a section.

ordernumber

Position within its group. nav.yaml wins where the two disagree.

Visibility

draftboolean

true keeps the page out of the published site, the sitemap, search, Ask and the content API. It is still in the repository and still visible in the writer.

noindexboolean

true serves the page but asks crawlers not to index it, and removes it from the sitemap.

Search engines

seo_titlestring

Overrides title in the <title> tag only. The page heading does not change.

seo_descriptionstring

Overrides description in the meta description only.

social_imagestring

The Open Graph and Twitter card image for this page.

canonicalstring

An absolute URL, when the authoritative copy of this page is somewhere else.

Moves

redirect_fromstring[]

Old paths that should redirect here. An alternative to redirects.yaml for a redirect that belongs to one page.

Freshness

ownerstring

The email address of the person answerable for this page. Pulse notifies them when a review is due. An address that is not a member fails unknown-owner.

review_everynumber

Days between reviews. Common values are 30, 90, 180 and 365.

last_revieweddate

The date somebody last confirmed this page is accurate. A reviewer can update it without changing a word of the text.

issuesstring[]

Known problems with this page, recorded on the page rather than in somebody’s head.

Machine authorship

ai_draftboolean

true marks the page as drafted with assistance and not yet reviewed by a person. The writer shows a badge. Remove the field when a person has read it.

generated_fromobject

Written by staleless document. It records the commit and the exact files and lines the page was derived from, so Pulse can mark the page for review when that code changes.

generated_from:
  commit: cb5eddcacfd934578314204dce9a2cdddf6366bf
  files:
    - path: src/api/teams.ts
      lines: [1, 2]

last_reviewed is deliberately absent from a generated page. A machine that wrote a page has not reviewed it.