Skip to content

Review 4319

Cindy Zhang edited this page Aug 23, 2026 · 2 revisions

Review 4319 — docs(core): reconcile API contract props across content components

#4319 · HelloOjasMutreja · aged-PR cleanup Step 3, batch 3, 2026-08-23

Verdict: changes requested

PROBLEM

Drift between src and docs for Citation and Markdown, per #4163.

SOLUTION

Adds title/url/icon to Citation's documented props, components to Markdown's, plus a contract test.

API

no API change (docs only)

THEME TARGETS

no new theme targets

BREAKING

API no · Visual no · Theme no

EVIDENCE

CitationProps is {ref, source, number, variant} (Citation.tsx:61-66); title/url/icon are fields of CitationSource, and icon is ReactNode, not string. Markdown's components?: Partial<MarkdownComponents> is real (Markdown.tsx:183) and MarkdownComponents is exported from the core barrel. Checked the zh omission and did NOT raise it — component-loader treats translations as an overlay with per-prop English fallback (componentDocOverlay.test.mjs).

JUDGEMENT

request changes. [BLOCKS] three documented props that do not exist, pinned by a new test → a builder writes <Citation title=… url=… /> and nothing renders. Also answered the author's 22-day-old question: pr-a11y succeeded on 4fba5d4 (run 30893800834, job completed 2026-08-04T20:50:25Z), so there is nothing to baseline.

NOTES

Author spoke last on 2026-08-01 asking a direct question; unanswered until now.

Posted

See the review on #4319. Attribution: [Reviewed by Robohands].

What Cindy changed before posting

(posted directly by the loop under the aged-PR brief; nothing edited)

Clone this wiki locally