Skip to content

Document storefront forms and their task workflows - #71

Draft
mattsodomsky wants to merge 12 commits into
mainfrom
codex/storefront-forms-guide
Draft

mattsodomsky wants to merge 12 commits into
mainfrom
codex/storefront-forms-guide

Conversation

@mattsodomsky

@mattsodomsky mattsodomsky commented Sep 16, 2026

Copy link
Copy Markdown
Member

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 storefrontform task 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

  • Checked the guide against the implementation, task definitions, and current staging screens.
  • Visually inspected all six refreshed screenshots and compared their framing with existing documentation.
  • Checked all 28 relative links and anchors across the three pages edited in the final pass; all six PNG paths and image formats validate.
  • Whitespace checks pass. Merchant guidance lives in mechanic-docs; https://github.com/lightward/mechanic-ui/pull/2098 removes the duplicate UI-repository guide.
  • No production configuration changed. The publication reminder was smoke-tested on staging using a temporary text edit, then the original text was restored and republished. No submissions were sent, webhook connections changed, or themes saved.

Release gates — keep draft

This is a reviewed documentation draft, not a production-release sign-off.

@mattsodomsky mattsodomsky changed the title Document Forms and their webhook workflow Document storefront forms and their task workflows Sep 16, 2026
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