Skip to content
GitHub
Sections

Reference · Things to avoid

Metadata that no longer matches the page

Forbidden
A title or description still carrying positioning the page dropped, changed in a later commit "when there is time"
Instead
Change the metadata in the same change as the copy. A page's title, description and preview text are copy, written by whoever wrote the headline, reviewed the same way.

What this rule looks like

Forbidden
Instead

Why this rule

This is the whole reason the section exists. A copy pass reads pages; nobody reads <head>. One site rewrote every visible page and served the old positioning to search for a day — including a metaphor whose explanation had been deleted the day before, so the stranger who met it had nowhere left to resolve it. The comment above that line already said "metadata is copy, when the positioning moves this moves with it". It had caught the problem once before and did not catch it again, because a comment is not a check.

Kind
Rule
Section
Things to avoid
Group
Search and sharing
Bucket
judgment
Severity
error
Since
v0.14.0

Read as plain text