Document storefront forms and their task workflows - #71
Draft
mattsodomsky wants to merge 12 commits into
Draft
mattsodomsky wants to merge 12 commits into
mattsodomsky wants to merge 12 commits into
Conversation
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
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.
Introduces Storefront forms as a way for customers to start Mechanic workflows: build questions visually, place the form in a theme, and connect ordinary Mechanic webhooks to tasks. Includes quote-request and warranty walkthroughs, plus wholesale and service examples using email, Google Sheets/Drive, and Shopify metaobject tasks.
The guide covers templates and layouts, webhook connections, publishing and the native form picker, placement lookup and its standard theme-read permission, previews versus real submissions, the 3 MB total upload limit, file storage and attachments, duplication, portable JSON, and stopping a form. Task-author payload details remain in the webhook reference. Cross-links connect the guide with the introduction, Settings, Permissions, Events, the webhook tutorial, and the theme FAQ. Staff-facing Run task forms are distinguished from storefront forms.
Current setup and screenshots
Six fresh screenshots show the current staging UI: starter templates, the visual builder, Submission settings with a copyable Form ID, Shopify's native form picker without the old code input, the Theme tab with a saved Home page placement, and the saved-changes publication reminder. They use native app-content crops, matching the existing Settings, task editor, and webhook documentation. Account navigation and developer overlays are excluded; alt text and captions describe each image.
The final review corrects form-name privacy (published names are publicly readable), documents the
storefrontformtask option, and puts publishing before task selection in the walkthroughs. It also makes preview behavior and email/Drive/metaobject file handling explicit. Publishing a form does not install tasks automatically.Validation
Release gates — keep draft
This is a reviewed documentation draft, not a production-release sign-off.