Back to Plate

sync shadcn docs structure mdx review

docs/plans/2026-05-30-sync-shadcn-docs-structure-mdx-review.md

53.0.810.5 KB
Original Source

sync shadcn docs structure mdx review

Objective: Run sync-shadcn review focused on docs structure, MDX components, code/copy primitives, and Fumadocs wiring between ../shadcn/apps/v4 and apps/www, producing a source-backed review artifact without patching apps/www.

Completion threshold: Complete when the upstream base, planned target, and current target are recorded as exact SHAs; upstream freshness is classified; docs/MDX owner paths are source-audited; explicit Plate forks and exclusions are checked; a durable review artifact is written under docs/sync/shadcn/reviews/; no implementation files are patched; and check-complete.mjs passes.

Verification surface:

  • ../shadcn git refs and apps/v4 diff/log commands.
  • docs/sync/shadcn/status.json and docs/sync/shadcn/decisions.md.
  • Source reads in apps/www/src/app/(app)/docs, apps/www/src/components, apps/www/src/lib, apps/www/source.config.ts, and matching upstream apps/v4 files.
  • Review artifact at docs/sync/shadcn/reviews/2026-05-30-docs-structure-mdx/review.md.

Constraints:

  • Review-only run: do not patch apps/www.
  • Do not advance lastSyncedCommit, lastPlannedCommit, lastPlan, or partialSyncs.
  • Do not write upstream .patch files.
  • Preserve settled Plate policy: no v0, no create/theme adoption, keep API MDX, CN docs, registry content, lazy registry-source loading, and Plate docs shell ownership.

Boundaries:

  • Allowed edits: this goal plan and docs/sync/shadcn/reviews/2026-05-30-docs-structure-mdx/**.
  • Non-goals: implementation, dashboard mutation, baseline advancement, registry build output, or broad shadcn mirroring.

Blocked condition: Blocked only if ../shadcn refs cannot be resolved, ancestry cannot be proven, the status file cannot be parsed, or the required review artifact cannot be written after one repair attempt.

Sync state:

  • base commit: 4a4dc8eb0fc793d8e9225e780183ad605f15d2c2
  • planned commit: efdec3ca4523e5edd8a714f633002a7addc203a1
  • current target: 67cef8fcb94a4223a144e8ed6cbd26169943db7a
  • selected plan: docs/sync/shadcn/runs/2026-05-29-4a4dc8e-to-efdec3c-editors-blocks-style/plan.md
  • review directory: docs/sync/shadcn/reviews/2026-05-30-docs-structure-mdx

Current verdict:

  • verdict: stale-upstream
  • confidence: high
  • reason: upstream has 2 newer apps/v4 commits after the tracked plan; the latest commits do not alter docs/MDX, but stable docs-engine differences were under-tracked.

Start Gates:

GateAppliesEvidence
autogoal loaded and active goal createdyesActive goal created for this review objective.
sync-shadcn skill readyesRead .agents/skills/sync-shadcn/SKILL.md.
Output budget strategy recordedyesBroad diffs were saved as TSV artifacts; no patch artifacts were written.
status.json readyesBaseline, planned target, last plan, and partial sync count recorded.
decisions.md readyesSettled Plate forks and exclusions used for classification.
Prior migration notes checkedyesPrior plans and solution notes were read before classification.
Upstream clone fetchedyes../shadcn origin/main resolved to 67cef8fcb94a4223a144e8ed6cbd26169943db7a.
Base and target refs resolvedyesExact SHAs recorded above and in refs.json.
Base ancestry provenyesmerge-base --is-ancestor succeeded for base to target.
Planning-only mode decidedyesThis review wrote artifacts only and did not patch apps/www.
User review boundary recordedyesNext action is dashboard row creation or explicit accepted implementation.

Work Checklist:

  • Objective, threshold, verification surface, constraints, boundaries, and blocked condition are filled from the active goal.
  • Upstream range recorded with exact base SHA, planned SHA, target SHA, commit dates, and target subject in review artifacts.
  • Review directory created under docs/sync/shadcn/reviews/.
  • Upstream inventories saved as upstream-full-name-status.tsv, upstream-full-numstat.tsv, upstream-new-name-status.tsv, and upstream-new-commits.txt.
  • Focused source files inspected on demand and summarized; no .patch files were written.
  • Visual screenshots marked N/A because this pass makes source/structure findings, not visual parity claims.
  • Changed upstream rows were counted and the new rows since lastPlannedCommit were classified at summary level.
  • Decision accounting for docs/MDX focus surfaces is recorded in review.md.
  • Added, modified, and stable comparison surfaces are summarized with actionable rows separated from forks/no-ops.
  • Recommended merge slices are ordered in review.md.
  • Settled exclusions and Plate forks are recorded with policy evidence.
  • Real decision rows are isolated: yarn tab, collapsible wrapper, highlight cache, copy fallback, MDX primitives.
  • status.json update semantics are recorded: unchanged for review mode.
  • Planning-mode handoff stops before implementation.
  • Workspace authority recorded for each verification command or artifact.
  • Output budget discipline followed; broad evidence stayed in artifacts.
  • Final handoff shape is prepared.

Completion Gates:

GateAppliesRequired actionEvidence
Named verification thresholdyesProve review artifact and no implementation editsreview.md written; only docs/sync review and goal plan touched.
Upstream range artifacts existyesVerify review artifacts are non-emptyTSV/log/refs files exist under the review directory.
Inventory completenessyesRecompute counts for current reviewFull inventory has 778 rows; new upstream delta has 40 rows.
Decision accountingyesRecord docs/MDX focus decisionsreview.md focus findings table lists each reviewed surface.
Status JSON parse and semanticsyesParse status.json; verify no mutation neededBaseline and planned target recorded; status unchanged.
Source-backed Plate mappingyesRecord file evidence for each focus surfacereview.md lists upstream and Plate owner files.
Visual comparison screenshotsN/ASource-only reviewNo visual parity claim was made.
Planning-only no implementation editsyesKeep apps/www untouchedReview-only artifact and goal plan edits only.
Accepted implementation verificationN/ANo accepted implementation in this turnReview mode only.
Browser surface changedN/ANo visible source patchBrowser proof not required.
Package manifests, lockfile, or install graph changedN/ANo package or lockfile editsNo install needed.
Agent rules or skills changedN/ANo rule or skill editsNo generated skill sync needed.
CI-controlled generated outputyesAvoid generated registry/template editsNo generated registry/template output touched.
Baseline advancementyesDo not advance baseline in review modelastSyncedCommit unchanged.
User review boundaryyesStop with recommendationsFinal response points to review artifact and next actions.
Output budget disciplineyesKeep broad evidence in artifactsBroad inventories saved as TSV files.
Goal plan completeyesRun check-complete.mjsRecorded in Verification evidence after command run.

Phase / pass table:

PhaseStatusEvidenceNext
Intake and baseline readcompletestatus, decisions, prior plans readdone
Upstream range evidencecompleterefs and TSV artifacts writtendone
Classification and local mappingcompletesource files inspecteddone
Review artifactcompletereview.md writtendone
User review stopcompleteimplementation left to later accepted slicedone
Verification and baseline decisioncompletebaseline unchanged by policydone
Closeoutcompletecheck-complete command requiredfinal response

Decision counts:

DecisionCountNotes
synced2PageHeader, TOC/no-op parity.
smart-merge4Code collapsible wrapper, highlight cache, copy fallback, selective MDX primitives.
plate-fork5Docs shell, source/search wiring, source.config ownership, docs copy menu, API/registry/CN behavior.
exclude-upstream2v0 and style/theme/create product rows stay excluded.
no-op1TOC memo difference is too small to track.
needs-question1Yarn tab policy.

Recommended merge slices:

OrderSliceClassFilesWhyVerification
1mdx/codeblock-collapsible-wrappersmart-mergeapps/www/src/components/code-block-wrapper.tsxClear upstream primitive improvement and local class bug candidate.focused typecheck plus docs page browser check
2mdx/highlight-code-cachesmart-mergeapps/www/src/lib/highlight-code.tsUpstream perf win with low Plate-specific risk.source check and registry/docs preview path
3mdx/copy-button-fallbacksmart-mergeapps/www/src/components/copy-button.tsxMore truthful copied state and clipboard fallback.focused browser copy check
4mdx/code-command-yarn-tabneeds-questionapps/www/src/lib/rehype-npm-command.ts, apps/www/src/components/code-block-command.tsx, apps/www/src/components/copy-button.tsxUpstream supports yarn; Plate currently has three package managers.decide policy first, then focused docs command check

Verification evidence:

  • refs.json records base=4a4dc8e, planned=efdec3c, target=67cef8f.
  • upstream-new-commits.txt has 2 rows.
  • upstream-new-name-status.tsv has 40 rows.
  • upstream-full-name-status.tsv has 778 rows.
  • Source reads compared upstream and Plate docs page shell, source.config.ts, mdx-components.tsx, source.ts, search route, code command, code collapsible wrapper, highlight code, copy button, docs copy page, TOC, and PageHeader.
  • review.md was written at docs/sync/shadcn/reviews/2026-05-30-docs-structure-mdx/review.md.
  • node .agents/rules/autogoal/scripts/check-complete.mjs docs/plans/2026-05-30-sync-shadcn-docs-structure-mdx-review.md passed.

Reboot status: Current review is complete enough to resume from review.md. If reopened, add the suggested dashboard rows first, then implement only an explicitly accepted slice.

Open risks:

  • No full dashboard JSON mutation was done in this review. The suggested rows still need to be copied into docs/sync/shadcn/deltas.json if the dashboard should track them.
  • The yarn tab is a product policy decision, not a code-only call.