Appearance
Documentation validation plan
Use this checklist to re-run the docs from a merchant’s perspective and funnel feedback into support + GitHub issues.
Smoke-test workflows
| Workflow | Docs to follow | Notes from dry run |
|---|---|---|
| First edit (install → filter → preview → rollback) | getting-started/install.md, getting-started/first-edit.md, tasks/job-history-rollback.md | Clear path from install to rollback, filter step now links to the dedicated guide; ensure UI exposes the same “Use pattern” button text as described. |
| Price change sale | tasks/filters-reference.md, tasks/update-prices.md, tasks/job-history-rollback.md | Emphasize preview + rollback; consider adding a reminder about compare-at relationships in-app (mirrors doc “Tips & limits”). |
| Tag cleanup with patterns | tasks/manage-tags.md, patterns-variables-reference.md#pattern-basics | Recipes show before/after tables; confirm pattern picker in UI uses the same variable labels. |
| Metafield population | tasks/filters-reference.md, tasks/edit-metafields.md, patterns-variables-reference.md#pattern-basics | Need to ensure metafield selector in UI calls out namespace/key just like the doc; otherwise add tooltip per audit. |
| CSV import fix + retry | tasks/csv-basics.md, troubleshooting/csv-errors.md, tasks/job-history-rollback.md | Docs cover header mapping, troubleshooting, and rollback exports. Validate that the import modal links to these sections (see in-app help audit). |
Log any gaps you find as GitHub issues with the doc path + exact confusion so we can iterate quickly.
Feedback loop
- Every “Was this helpful?” section now links to the Support & contact checklist plus GitHub Issues so merchants can escalate with the right context.
- Support responses should capture the doc path referenced and whether an update is needed; paste that context into the GitHub issue template when filing.
- Review issue intake weekly, group similar feedback (filters, rollback, CSV, billing), and prioritize doc edits alongside UI microcopy from
in-app-help-audit.md.