docs(spec): scrub stale compactLayout teachings + orphaned defaultDetailForm JSDoc (ADR-0085 remnants)#2530
Merged
Merged
Conversation
…ailForm JSDoc (ADR-0085 remnants) Follow-up to the ADR-0085 hand-written docs sweep (#2529) — these two remnants live in code and regenerate into docs: - RecordDetailsProps layout/fields descriptions taught the deprecated compactLayout name; now teach the canonical highlightFields (compactLayout remains a supported alias). Regenerated react-blocks contract + reference md. - Removed an orphaned JSDoc block for defaultDetailForm in object.zod.ts — the prop was never implemented and was removed from the spec in #2402. Doc-text only; no schema shape or behavior change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
Contributor
📓 Docs Drift CheckThis PR changes 1 package(s): 92 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to the ADR-0085 hand-written docs sweep (#2529). Two stale remnants live in code and regenerate into docs, so they survived the docs-only sweep:
RecordDetailsProps(packages/spec/src/ui/component.zod.ts) — thelayoutandfieldsprop descriptions taught the deprecatedcompactLayoutname. Renamed to the ADR-0085 canonicalhighlightFields(compactLayoutremains a supported alias per the bidirectional mirror inobject.zod.ts). Regeneratedskills/objectstack-ui/contracts/react-blocks.contract.jsonandskills/objectstack-ui/references/react-blocks.mdviapnpm gen:react-blocks.packages/spec/src/data/object.zod.ts— removed an orphaned JSDoc block describingdefaultDetailForm, a prop that was never implemented and was removed from the spec in feat(spec): remove first batch of dead metadata props (#2377, A2) #2402. The comment had no property attached.Doc-text only; no schema shape or behavior change. Patch changeset included.
Refs: ADR-0085, #2529, #2402
Test plan
pnpm --filter @objectstack/spec build✅pnpm gen:react-blocksregenerated contract + reference doc (only the two description strings changed) ✅🤖 Generated with Claude Code