Skip to content

Review 5330

Cindy Zhang edited this page Aug 23, 2026 · 1 revision

#5330 — docs(Avatar): restore the missing dense best-practice bullet

josephfarina · MERGED · view on GitHub

Verdict: approve

Head reviewed: 2692e398f1d9424efe8c00fa27f72d7f15a53146

Problem

The English Avatar docs list eight best practices; docsDense had seven. The "a status label is not a name" anti-pattern had been folded onto the end of the adjacent do-bullet, so the dense catalog lost it as a separate don't.

Solution

Split the compound bullet: the do keeps the dev-warning sentence, and the anti-pattern becomes its own guidance: false entry with the reason attached.

Impact

Anyone reading the dense Avatar docs — the CLI's authoring surface and agents consuming docsDense. No runtime code touched.

API

No API change.

Theme targets

No new theme targets.

Breaking

  • API — no. Visual — no, docs only. Theme — no.

Performance & resources

Nothing — no runtime code in the diff.

Risk class

Low-risk — no new API surface, no behavior regression, no performance regression.

Judgement

approve — the anti-pattern reads better as its own don't than folded onto the do, and dense now matches the English list at eight.

The review, as posted

Thanks — the anti-pattern reads better as its own don't than folded onto the do.

What changed before posting

Posted as drafted.

Clone this wiki locally