Project portfolio Browse selected work

Shopify Plus Upgrade Monthly Fee Reduction + Up to $4800 Development Fee Credit - Exclusive WesWoo Offer

Shopify Developer Guides / Help, manuals and policies

Shopify Help, manuals and policies

Connect questions and models to resources, applicable policies, accounts and human support.

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
  1. Create the metaobject definitions documented in HANDOFF.md; enable storefront access and select reviewed records.
  2. Add the Section to a development JSON template and merge locale leaf keys without replacing theme locale files.
  3. 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
Liquid · WESWOO
{% 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
JSON · WESWOO
{
  "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
JSON · WESWOO
{
  "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
JSON · WESWOO
{
  "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
JavaScript · WESWOO
// 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
Liquid · WESWOO
{% 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.

Read it, integrate it, verify it

  1. Choose a module and confirm the data contract.
  2. Connect the fragment to the current theme or framework.
  3. 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.

Shopify/dawn · Licensecommit 3e9ee2281dc4 · Shopify-integration theme license; architecture reference without copying the implementation.
Shopify/hydrogen · Licensecommit 9e358a2462ba · MIT; retain copyright and license when using substantial code.

References checked 2026-11-17