Shopify Help, manuals and policies
Connect questions and models to resources, applicable policies, accounts and human support.
Model-specific expandable FAQ
Use real compatibility, usage, order and support tasks. Preserve conditions and next steps in each answer. Native details provide a no-script baseline before optional grouping enhancements.
Data and dependencies
- custom.faqs: list.metaobject_reference.
- question is text; answer is rich text; guide is a page reference.
Interaction logic
- Allow keyboard and touch disclosure.
- Keep the answer without inventing a missing guide link.
Example code · snippets/ww-faq.liquid
{% assign questions = product.metafields.custom.faqs.value %}
{% if questions != blank %}
<section aria-labelledby="Questions-{{ section.id }}">
<h2 id="Questions-{{ section.id }}">Questions about this model</h2>
{% for question in questions %}
<details>
<summary>{{ question.question.value | escape }}</summary>
<div>{{ question.answer | metafield_tag }}</div>
{% if question.guide.value != blank %}
<a href="{{ question.guide.value.url | escape }}">Read the guide</a>
{% endif %}
</details>
{% endfor %}
</section>
{% endif %}
Acceptance checks
- Locate the complete answer in initial HTML.
- Verify model, region, version and related pages.
Treat FAQ as readable help content. Do not generate unsuitable FAQPage markup or copy inapplicable terms.
Official documentation
WESWOO guides
Model index, instructions and manuals
Index manuals by model, version and language. Keep key installation or troubleshooting steps in HTML and offer the full PDF separately, with explicit product/manual relationships.
Data and dependencies
- The Section records setting is a ww_manual metaobject_list. Select reviewed storefront-visible records in the editor.
- model is required; aliases/revision/language are text, instructions is rich text, download is a controlled PDF file reference, and product is an optional product reference.
Interaction logic
- Native details expand each model; omit empty revision/language separators.
- Missing files retain reviewed HTML instructions and contact links; never substitute another model manual.
Integration and initialization
- Create the metaobject definitions documented in HANDOFF.md; enable storefront access and select reviewed records.
- Add the Section to a development JSON template and merge locale leaf keys without replacing theme locale files.
- Load help script once with defer from theme.liquid; custom element connection/disconnection handles editor rerenders and listener cleanup.
Example code · sections/ww-manual-index.liquid
<section aria-labelledby="Manuals-{{ section.id }}">
<h2 id="Manuals-{{ section.id }}">{{ 'ww_support.manuals' | t }}</h2>
{% assign valid_count = 0 %}
{% for record in section.settings.records %}
{% assign file = record.download.value %}
{% if record.model.value != blank %}
{% assign valid_count = valid_count | plus: 1 %}
<details><summary>{{ record.model.value | escape }}{% if record.revision.value != blank %} · {{ record.revision.value | escape }}{% endif %}{% if record.language.value != blank %} · {{ record.language.value | escape }}{% endif %}</summary>
{% if record.aliases.value != blank %}<p>{{ record.aliases.value | escape }}</p>{% endif %}
{% if record.instructions.value != blank %}{{ record.instructions | metafield_tag }}{% endif %}
{% if file != blank and file.media_type == 'generic_file' and file.url != blank %}
<a href="{{ file.url | escape }}">{{ 'ww_support.download' | t }}</a>
{% else %}<p>{{ 'ww_support.no_file' | t }}</p>{% endif %}
{% if record.product.value != blank %}<a href="{{ record.product.value.url | escape }}">{{ record.product.value.title | escape }}</a>{% endif %}
</details>
{% endif %}
{% endfor %}
{% if valid_count == 0 %}<p>{{ 'ww_support.empty' | t }}</p>{% endif %}
{% if section.settings.contact != blank %}<a href="{{ section.settings.contact | escape }}">{{ 'ww_support.contact' | t }}</a>{% endif %}
</section>
{% schema %}
{
"name": "WESWOO manual-index",
"settings": [
{
"type": "metaobject_list",
"id": "records",
"label": "Reviewed records",
"metaobject_type": "ww_manual",
"limit": 50
},
{
"type": "url",
"id": "contact",
"label": "Contact page"
}
],
"presets": [
{
"name": "WESWOO manual-index"
}
]
}
{% endschema %}
Example code · locales/en.default.json
{
"ww_support": {
"manuals": "Manuals and instructions",
"download": "Open reviewed manual",
"no_file": "Download unavailable; use the instructions or contact us.",
"empty": "No published records available.",
"contact": "Contact support",
"help": "Help resources",
"query": "Model or question",
"search_all": "Search store pages and articles",
"clear": "Clear local filter",
"scope": "The local filter checks only the links listed on this page.",
"no_match": "No local matches. Clear the filter, search the store, or contact support.",
"stores": "Stores",
"open_map": "Open external map (new tab)",
"no_map": "Map unavailable; use the address above.",
"count": "[count] resources in this page index."
}
}Example code · locales/zh-CN.json
{
"ww_support": {
"manuals": "手册与操作说明",
"download": "打开已核手册",
"no_file": "下载暂不可用,请阅读说明或联系支持。",
"empty": "暂无已发布记录。",
"contact": "联系支持",
"help": "帮助资源",
"query": "型号或问题",
"search_all": "搜索商店页面与文章",
"clear": "清空本页筛选",
"scope": "本页筛选仅匹配下方列出的链接。",
"no_match": "本页无匹配,请清空筛选、搜索全站或联系支持。",
"stores": "门店",
"open_map": "打开外部地图(新标签页)",
"no_map": "地图暂不可用,请使用上方文字地址。",
"count": "本页目录有 [count] 条匹配资源。"
}
}Example code · locales/zh-TW.json
{
"ww_support": {
"manuals": "手冊與操作說明",
"download": "開啟已核手冊",
"no_file": "下載暫不可用,請閱讀說明或聯絡支援。",
"empty": "暫無已發佈記錄。",
"contact": "聯絡支援",
"help": "協助資源",
"query": "型號或問題",
"search_all": "搜尋商店頁面與文章",
"clear": "清空本頁篩選",
"scope": "本頁篩選僅比對下方列出的連結。",
"no_match": "本頁無符合項目,請清空篩選、搜尋全站或聯絡支援。",
"stores": "門市",
"open_map": "開啟外部地圖(新分頁)",
"no_map": "地圖暫不可用,請使用上方文字地址。",
"count": "本頁目錄有 [count] 條符合資源。"
}
}Acceptance checks
- Download the actual file and check its version.
- Check aliases, language and product backlinks.
- Test empty/draft/missing fields, three locales, no JS and editor reorder/delete/rerender; target-store acceptance remains pending.
The example does not upload manuals. Verify every file and do not substitute a different model manual.
Regional shipping, returns and warranty
Match the region to applicable terms before reusing summaries across product, reassurance and help modules. Re-evaluate after a region change and do not substitute arbitrary terms for an unmatched region.
Data and dependencies
- shop.custom.market_policies: list.metaobject_reference.
- country_code/title/summary are text; policy_page is a page reference.
- shop.custom.policy_index: page_reference; explicitly select a reviewed public policy index page.
Interaction logic
- Render current-country records only when title, summary and full policy page are present.
- Show unconfirmed terms without a match; link only to an explicitly configured policy index.
Integration and initialization
- Define market_policies and optional policy_index first, referencing reviewed public pages.
- Merge ww_policy from the three locale examples into the theme's corresponding language files, preserving all other keys.
- Re-render the Section after storefront-country changes; verify metaobject access and page availability in the target store.
Example code · snippets/ww-market-policy.liquid
{% assign policies = shop.metafields.custom.market_policies.value %}
{% assign country_code = localization.country.iso_code %}
{% assign matched = false %}
{% for policy in policies %}
{% if policy.country_code.value == country_code and policy.title.value != blank and policy.summary.value != blank and policy.title.value and policy.summary.value and policy.policy_page.value.url and policy.policy_page.value.url != blank %}
{% assign matched = true %}
<section>
<h2>{{ policy.title.value | escape }}</h2>
<p>{{ policy.summary.value | escape }}</p>
{% if policy.policy_page.value != blank %}
<a href="{{ policy.policy_page.value.url | escape }}">{{ 'ww_policy.read_applicable' | t }}</a>
{% endif %}
</section>
{% endif %}
{% endfor %}
{% unless matched %}
<section>
<h2>{{ 'ww_policy.unconfirmed_heading' | t }}</h2>
<p>{{ 'ww_policy.unconfirmed_body' | t }}</p>
{% assign policy_index = shop.metafields.custom.policy_index.value %}
{% if policy_index and policy_index.url and policy_index.url != blank %}
<a href="{{ policy_index.url | escape }}">{{ 'ww_policy.open_index' | t }}</a>
{% endif %}
</section>
{% endunless %}
Example code · locales/en.default.json · merge ww_policy keys
{
"ww_policy": {
"read_applicable": "Read the applicable policy",
"unconfirmed_heading": "Regional terms not yet confirmed",
"unconfirmed_body": "Applicable terms for the selected region have not yet been confirmed.",
"open_index": "View policy index"
}
}
Example code · locales/zh-CN.json · merge ww_policy keys
{
"ww_policy": {
"read_applicable": "阅读适用政策",
"unconfirmed_heading": "地区条款尚未确认",
"unconfirmed_body": "当前所选地区的适用条款尚未确认。",
"open_index": "查看政策索引"
}
}
Example code · locales/zh-TW.json · merge ww_policy keys
{
"ww_policy": {
"read_applicable": "閱讀適用政策",
"unconfirmed_heading": "地區條款尚未確認",
"unconfirmed_body": "目前所選地區的適用條款尚未確認。",
"open_index": "查看政策索引"
}
}
Acceptance checks
- Compare policy text, summary and service ownership.
- Check region changes, return conditions and required evidence.
Country matching is an example. Model multi-country markets, B2B contracts and product exceptions explicitly.
Official documentation
WESWOO guides
Shopify help-center model and problem indexes
Create a linked directory of models, manuals, policies and contact paths before adding local filtering. Retain full-store help search when the local index has no match, and make its search scope explicit.
Data and dependencies
- Select ww_help_topic entries in the Section records setting. title/destination are required; models/purpose supply readable model aliases and task terms.
- Local matching covers rendered records only. GET uses routes.search_url with type=page,article. Merchants maintain destination/content languages; contact is optional.
Interaction logic
- Local filtering hides existing rows and announces the count.
- A zero result offers clearing, full search or human help.
Integration and initialization
- Create the metaobject definitions documented in HANDOFF.md; enable storefront access and select reviewed records.
- Add the Section to a development JSON template and merge locale leaf keys without replacing theme locale files.
- Render ww-support-assets once before the closing body in theme.liquid, never in each Section; custom element connection/disconnection cleans up editor rerenders.
States, triggers and feedback
- Full indexEnter a query → Match this page only
- No matchClear or search all → Restore the index or enter full search
- No scriptRead links → All listed resources remain reachable
Example code · sections/ww-help-routing.liquid
{% assign valid_count = 0 %}
{% for record in section.settings.records %}
{% if record.title.value != blank and record.destination.value != blank %}
{% assign valid_count = valid_count | plus: 1 %}
{% endif %}
{% endfor %}
<ww-support-index>
<h2>{{ 'ww_support.help' | t }}</h2>
<form action="{{ routes.search_url | escape }}" method="get" role="search">
<label for="HelpQuery-{{ section.id }}">{{ 'ww_support.query' | t }}</label>
<input id="HelpQuery-{{ section.id }}" name="q" type="search" data-query>
<input type="hidden" name="type" value="page,article">
<button type="submit">{{ 'ww_support.search_all' | t }}</button>
<button type="button" data-clear hidden>{{ 'ww_support.clear' | t }}</button>
</form>
<p>{{ 'ww_support.scope' | t }}</p>
<p role="status" aria-live="polite" data-count data-template="{{ 'ww_support.count' | t | escape }}"></p>
<p data-empty{% if valid_count > 0 %} hidden{% endif %}>{{ 'ww_support.no_match' | t }}</p>
<ul>
{% for record in section.settings.records %}
{% assign destination = record.destination.value %}
{% if record.title.value != blank and destination != blank %}
<li data-row data-key="{{ record.title.value | append: ' ' | append: record.models.value | append: ' ' | append: record.purpose.value | escape }}">
<a href="{{ destination | escape }}">{{ record.title.value | escape }}</a>
{% if record.models.value != blank %}<span>{{ record.models.value | escape }}</span>{% endif %}
</li>
{% endif %}
{% endfor %}
</ul>
{% if section.settings.contact != blank %}<a href="{{ section.settings.contact | escape }}">{{ 'ww_support.contact' | t }}</a>{% endif %}
</ww-support-index>
{% schema %}
{
"name": "WESWOO help-routing",
"settings": [
{
"type": "metaobject_list",
"id": "records",
"label": "Reviewed records",
"metaobject_type": "ww_help_topic",
"limit": 50
},
{
"type": "url",
"id": "contact",
"label": "Contact page"
}
],
"presets": [
{
"name": "WESWOO help-routing"
}
]
}
{% endschema %}
Example code · locales/en.default.json
{
"ww_support": {
"manuals": "Manuals and instructions",
"download": "Open reviewed manual",
"no_file": "Download unavailable; use the instructions or contact us.",
"empty": "No published records available.",
"contact": "Contact support",
"help": "Help resources",
"query": "Model or question",
"search_all": "Search store pages and articles",
"clear": "Clear local filter",
"scope": "The local filter checks only the links listed on this page.",
"no_match": "No local matches. Clear the filter, search the store, or contact support.",
"stores": "Stores",
"open_map": "Open external map (new tab)",
"no_map": "Map unavailable; use the address above.",
"count": "[count] resources in this page index."
}
}Example code · locales/zh-CN.json
{
"ww_support": {
"manuals": "手册与操作说明",
"download": "打开已核手册",
"no_file": "下载暂不可用,请阅读说明或联系支持。",
"empty": "暂无已发布记录。",
"contact": "联系支持",
"help": "帮助资源",
"query": "型号或问题",
"search_all": "搜索商店页面与文章",
"clear": "清空本页筛选",
"scope": "本页筛选仅匹配下方列出的链接。",
"no_match": "本页无匹配,请清空筛选、搜索全站或联系支持。",
"stores": "门店",
"open_map": "打开外部地图(新标签页)",
"no_map": "地图暂不可用,请使用上方文字地址。",
"count": "本页目录有 [count] 条匹配资源。"
}
}Example code · locales/zh-TW.json
{
"ww_support": {
"manuals": "手冊與操作說明",
"download": "開啟已核手冊",
"no_file": "下載暫不可用,請閱讀說明或聯絡支援。",
"empty": "暫無已發佈記錄。",
"contact": "聯絡支援",
"help": "協助資源",
"query": "型號或問題",
"search_all": "搜尋商店頁面與文章",
"clear": "清空本頁篩選",
"scope": "本頁篩選僅比對下方列出的連結。",
"no_match": "本頁無符合項目,請清空篩選、搜尋全站或聯絡支援。",
"stores": "門市",
"open_map": "開啟外部地圖(新分頁)",
"no_map": "地圖暫不可用,請使用上方文字地址。",
"count": "本頁目錄有 [count] 條符合資源。"
}
}Example code · assets/ww-support-index.js
// Original WESWOO teaching example. Load once with defer from theme.liquid.
if (!customElements.get('ww-support-index')) {
customElements.define('ww-support-index', class extends HTMLElement {
connectedCallback() {
this.controller?.abort();
this.controller = new AbortController();
const input = this.querySelector('[data-query]');
const clear = this.querySelector('[data-clear]');
const empty = this.querySelector('[data-empty]');
const status = this.querySelector('[data-count]');
const rows = [...this.querySelectorAll('[data-row]')];
if (!input || !clear || !empty) return;
const normalize = value => value.normalize('NFKC').trim().toLocaleLowerCase();
const update = () => {
const query = normalize(input.value);
let count = 0;
rows.forEach(row => {
row.hidden = !normalize(row.dataset.key || '').includes(query);
if (!row.hidden) count++;
});
empty.hidden = count !== 0;
if (status) status.textContent = status.dataset.template.replace('[count]', String(count));
clear.hidden = !query;
};
input.addEventListener('input', event => { if (!event.isComposing) update(); }, {signal:this.controller.signal});
input.addEventListener('compositionend', update, {signal:this.controller.signal});
clear.addEventListener('click', () => { input.value=''; update(); input.focus(); }, {signal:this.controller.signal});
update();
}
disconnectedCallback() { this.controller?.abort(); }
});
}
Example code · snippets/ww-support-assets.liquid
{% comment %}Render once in layout/theme.liquid before </body>, never inside each Section.{% endcomment %}
<script src="{{ 'ww-support-index.js' | asset_url }}" defer></script>
Acceptance checks
- Test model names, problem fragments and an unmatched query.
- Disable JavaScript and follow every manual and policy destination.
- Test empty/draft/missing fields, three locales, no JS and editor reorder/delete/rerender; target-store acceptance remains pending.
This filters a curated page index. Maintain the references and use real pagination or server search for larger libraries.
Official documentation
- Metaobjects and publication
- Storefront search result types
- Locale-aware routes
- Metaobject list Section settings
Implementation references
WESWOO guides
Account self-service and contact forms
Use the platform account route and submit help questions through a labelled native form. Field errors, server acceptance and subsequent human handling are separate states.
Data and dependencies
- routes.account_login_url.
- contact[email], contact[body] and form result.
Interaction logic
- Show success only after posted_successfully?.
- Keep errors near the form without claiming resolution.
Example code · snippets/ww-support-contact.liquid
<a href="{{ routes.account_login_url | escape }}">Open your customer account</a>
{% assign support_form_id = 'Support-' | append: section.id %}
{% form 'contact', id: support_form_id %}
<label for="Email-{{ section.id }}">Email</label>
<input id="Email-{{ section.id }}" name="contact[email]" type="email" autocomplete="email" required>
<label for="Message-{{ section.id }}">Model and question</label>
<textarea id="Message-{{ section.id }}" name="contact[body]" required></textarea>
<button type="submit">Send the question</button>
{% if form.posted_successfully? %}
<p role="status">Your message was submitted.</p>
{% else %}
<div role="alert">{{ form.errors | default_errors }}</div>
{% endif %}
{% endform %}
Acceptance checks
- Test required fields and receipts with approved data.
- Check account configuration, redirects and phone use.
A contact form does not authorize order actions. Keep credentials and sensitive payment data out of public message fields.
Shopify customer accounts, sign-in and orders
Confirm the configured account system and use Shopify routes for sign-in and orders. Returning to the storefront and opening the order index are different destinations.
Data and dependencies
- shop.customer_accounts_enabled controls the entry group.
- customer reflects the theme customer session; the configured account service owns authentication.
Interaction logic
- Signed-out users can choose orders or a return-to-store sign-in destination.
- Signed-in users see account and logout links; disabled accounts omit the group.
Integration and initialization
- Confirm account settings and desired return destination.
- Render the routes-based fragment in navigation or help.
- Test the actual account service and retain policy/contact routes for unimplemented self-service.
States, triggers and feedback
- Accounts disabledRender → Omit account entries
- Signed outChoose destination → Use the corresponding Shopify sign-in route
- Signed inOpen account → Reach orders and account services
Example code · snippets/ww-account-links.liquid
{% if shop.customer_accounts_enabled %}
<nav aria-label="Customer self service">
{% if customer %}
<a href="{{ routes.account_url | escape }}">Orders and account</a>
<a href="{{ routes.account_logout_url | escape }}">Sign out</a>
{% else %}
<a href="{{ routes.account_login_url | escape }}">Sign in to view orders</a>
<a href="{{ routes.storefront_login_url | escape }}">Sign in and return to the store</a>
{% endif %}
</nav>
{% endif %}
Acceptance checks
- Check signed-out, signed-in and disabled-account states.
- Complete a test login and verify its destination; link only implemented warranty functions.
The fragment handles routes, not passwords. Do not hard-code a presumed account URL or authentication version.
Official documentation
Implementation references
Read it, integrate it, verify it
- Choose a module and confirm the data contract.
- Connect the fragment to the current theme or framework.
- Check real variants, markets and recovery states.
Educational implementations for Shopify themes and Headless projects. Confirm real inputs, interaction states and existing components in a development theme before store acceptance. Missing task-specific WESWOO articles remain unlinked.
Architecture references
Original educational examples with Shopify documentation and pinned upstream references. Follow the applicable license when adopting repository code.
References checked 2026-11-17