Skip to content
Patens

Brief design notes missing

Audit code: brief-no-design-notes

Definition

The brief has no design notes. Notes are where you record decisions ("contrast is monoline", "g is single-storey") so future-you doesn't reinvent them. Not required for export — recommended for any project you'll revisit.

How Patens surfaces this

The Patens audit module checks for brief-no-design-notes across five teaching surfaces: the edit-panel inline issue list, the project-wide audit page, the release pre-flight check, the family hub, and the home-page project tile. Every surface shows the same plain-English explanation and links back to this page. This rule is detection-only — there's no automatic fix because the correction is design-dependent (it requires a judgment call about the glyph's intended shape or the font's intended behaviour). The audit message links to the specific glyph or field that needs attention.

Run this check yourself

Patens runs every audit rule live as you draw — including this one. The editor (in private alpha) shows brief-no-design-notes firing on real glyphs, or check your own work from the CLI:

npx patens audit your-project.font.json

Related rules in Brief

← All 94 audit rules