Skip to content

Review 5331

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

#5331 — docs(cli): document the integration manifest docs field in the README

josephfarina · OPEN · view on GitHub

Verdict: approve with nits

Head reviewed: 3ea09266663bb5b5773c700dc95b8ed609f120e9

Problem

The integration manifest accepts an optional docs field — a directory whose {topic}.doc.* files become CLI-served topics — and the package-roots table in the CLI README did not list it.

Solution

One row added to the table.

Impact

Anyone writing an integration manifest from the README. No runtime code.

API

No API change — documents an existing field.

Theme targets

No new theme targets.

Breaking

  • API — no. Visual — no. 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 with a nit

1. The README's tables are generated (`pnpm -F @astryxdesign/cli readme`) and
   the hand edit leaves the column padding out of sync
   → `readme-gen.test.mjs` is red, so the PR cannot merge until the generator
     runs. Verified on a clean main worktree: main passes the check, this diff
     fails it, and running the generator keeps the new row and only re-pads the
     columns                          · packages/cli/test/readme-gen.test.mjs:25

The review, as posted

Thanks — the row is right, the generator just re-pads the columns. pnpm -F @astryxdesign/cli readme and commit; that's the red test.

What changed before posting

Posted as drafted.

Clone this wiki locally