Skip to content

docs(turbosign): split Conditional Fields into UI and API/SDK sections - #151

Merged
nicolasiscoding merged 1 commit into
developfrom
docs/conditional-fields-ui-split
Aug 25, 2026
Merged

docs(turbosign): split Conditional Fields into UI and API/SDK sections#151
nicolasiscoding merged 1 commit into
developfrom
docs/conditional-fields-ui-split

Conversation

@nicolasiscoding

Copy link
Copy Markdown
Member

What & why

The Conditional (IF/THEN) Fields page was written entirely for API/SDK developers — metadata contract, code samples, validation — with no path for someone setting conditional fields up in the app. A reader who builds documents in the TurboSign UI had nothing to follow.

This splits the page cleanly by audience while keeping all the existing API content:

  • Shared intro — what conditional fields are, and the two behaviors (Show vs Unlock).
  • In the app — a new step-by-step how-to with annotated screenshots (add a checkbox + the field it controls, then set the rule under "Only show this field sometimes").
  • With the API and SDKs — the existing reference, unchanged in substance.
  • How the app maps to the API — a crosswalk table so the two forms are obviously the same thing.

Screenshots

Captured with /guidewright-capture against the live app; walked with /guidewright-review first. Every screenshot uses an ACME Inc sample document and recipient — no customer or environment data.

  • 01-field-editor.png — the Assign Fields editor + palette
  • 02-add-fields.png — palette with Checkbox and Text highlighted
  • 03-rule-builder.png — the "Only show this field sometimes" rule builder highlighted

Notes

  • UI labels in the doc were verified against the app's ConditionalFieldSettings component (Ticked / Not ticked, Hidden / Visible-but-not-fillable), so the crosswalk is accurate.
  • No structural changes to the API reference; example emails normalized to @acme.com.

The page was API/SDK-only, which buried the fact that conditional fields
can be built in the app. Restructure into a shared concept intro, an 'In
the app' how-to with annotated screenshots, the existing API/SDK
reference, and a UI-to-API crosswalk table.
@nicolasiscoding nicolasiscoding self-assigned this Aug 25, 2026
@nicolasiscoding
nicolasiscoding marked this pull request as ready for review August 25, 2026 12:01
@nicolasiscoding
nicolasiscoding merged commit 3c2b23b into develop Aug 25, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant