docs(spec): make submitBehavior's TSDoc state the mode-aware default - #7473
Merged
Conversation
…7441) The JSDoc block above `FormViewSchema.submitBehavior` still claimed `thank-you` (default) — show a confirmation panel, which the maintainer's 2026-08-10 ruling on #7245 makes false for the internal path: `thank-you` stays the default only on the public `/console/f/:slug` path, while the internal `/console/forms/:name` path — where `type: 'form'` actions send operators — now defaults to redirecting to the record that was just created. An explicit `submitBehavior` wins in either mode. Rewritten to state both defaults and the reasoning behind each, mirroring the contract already landed in content/docs/protocol/objectui/actions.mdx and content/docs/ui/forms.mdx (PR #7417). Schema unchanged: submitBehavior stays .optional() with no .default(), and its .describe() string ('Post-submit behavior') is byte-identical — only the source comment changes. Fixes #7441 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016R9de1FqP7NvwKvqXi92Gh
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
Contributor
📓 Docs Drift CheckThis PR changes 1 package(s): 106 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
⛔ 7 release-owned page(s) also reference the affected code. These are read-only:
|
github-actions
Bot
added
documentation
os-help
marked this pull request as ready for review
August 10, 2026 15:44
This was referenced Aug 11, 2026
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
2 participants
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.
Fixes #7441
What changed
packages/spec/src/ui/view.zod.ts, the JSDoc block aboveFormViewSchema.submitBehavior(~line 2029), still claimed:The maintainer's 2026-08-10 ruling on #7245 makes that mode-dependent:
thank-youstays the default only for the public/console/f/:slugpath, while the internal/console/forms/:namepath — wheretype: 'form'actions send operators — now defaults to redirecting to the created record. An explicitsubmitBehaviorwins in either mode.Before:
After:
The rewrite mirrors the contract already landed in
content/docs/protocol/objectui/actions.mdxandcontent/docs/ui/forms.mdx(PR #7417).Scope discipline
⛔ The schema itself is untouched:
submitBehaviorstays.optional()with no.default(), and its.describe()string ('Post-submit behavior') is byte-identical.git diffconfirms only comment lines changed. No acceptance-face change.Hypotheses verified
gen:docs) — HOLDS.pnpm --filter @objectstack/spec check:docsreports "231 generated files in sync with packages/spec" (same count PR docs(spec): state the RLSusinggrammar by what pushes down, not by a count (#6919) #7444 cited for the identical reason), andgit status --porcelain -- content/docs/references/is empty after the check.submitBehavior-referencing test files; the only matches (view-strictness-batch18.test.ts) pin schema behavior (strict-key rejection, discriminated-union error shape), never the JSDoc prose. No pin needed updating; no new gate machinery was added.Verification
Changeset
.changeset/submitbehavior-jsdoc-mode-aware-default.md— patch,@objectstack/spec, following PR #7444's precedent (TSDoc contract-text rewrite in published spec source ships a patch changeset even thoughgen:docsrenders nothing from it).Refs #7245 (the ruling) · #7417 (docs half, where this was flagged) · objectui#4109 (renderer half, not yet landed).
Generated by Claude Code