Skip to content
MigreLief — Theme Docs

Docs Backlog

This site was scaffolded partway into the build, so it covers only what was in flight at the time. Everything below still needs writing.

Current coverage: 87 of 126 — 33 of 51 sections, 54 of 75 blocks.

Going forward, new work is documented as it’s built (see Keeping Docs Current). This backlog is for clearing what predates that rule.

Already documented

Section titled “Already documented”

Priority 1 — Merchant-facing sections

Section titled “Priority 1 — Merchant-facing sections”

The sections content editors touch most. Highest value per page written.

  • text-image-split

Priority 2 — Product page

Section titled “Priority 2 — Product page”
  • Blocks: product-title

The rest of the product page is now documented: main-product plus product-form-submit, product-variant-options, product-stock-message, product-sale-description, product-reviews-overview, bundle-group, related-articles and product-card.

Priority 3 — Collection

Section titled “Priority 3 — Collection”
  • Sections: main-list-collections, hero-collection
  • Blocks: collection-sale-description

Priority 4 — Header internals

Section titled “Priority 4 — Header internals”
  • header-actions, header-content-area-left, header-content-area-right
  • header-search-toggle, header-account-icon, header-account-icon-mobile, header-cart-icon
  • header-nav-link, header-nav-featured-product, header-nav-page-link
  • header-featured-products, header-meganav-menu

Mostly developer-facing — the Header page covers what merchants need. Low urgency.

Priority 5 — Cart & account

Section titled “Priority 5 — Cart & account”
  • Sections: cart, main-cart-items, customers-* (account, login, register, addresses, order, activate-account, reset-password)
  • The React cart drawer — architecture, upsells, quantity handling

Priority 6 — Utility & system

Section titled “Priority 6 — Utility & system”
  • main-page, main-404, storefront-password, style-guide
  • breadcrumb

Conventions still to write

Section titled “Conventions still to write”
  • Accessibility — the WCAG 2.2 AA baseline this build holds itself to. Form-specific rules (target size, colour-independent errors, contrast floors for borders) are already covered in Forms — this page should cover the sitewide baseline and link there rather than repeat it.
  • Performance — Core Web Vitals targets, image handling, JS discipline
  • Images — responsive-image.liquid parameters and srcset conventions
  • Alpine patterns — how components are registered and how sections talk to each other via events
  • Translations — deeper than the current summary
  • Metaobjects — the tag system and any others introduced

Written: Colours, Spacing & Layout, Liquid & Schema, Metafields, Forms.

Metafield cleanup (pre-launch)

Section titled “Metafield cleanup (pre-launch)”

Surfaced while writing Metafields. Not docs work — theme and store work, tracked here so it isn’t lost.

  • Confirm whether the undefined custom.* / custom_fields.* keys hold values. Thirteen keys are read by the theme with no definition in the store. Needs a value-level query; the definitions pull can’t answer it.
  • Triage the 28 migrelief definitions with no reader. Built-not-yet-wired versus stale — decide per key before launch.
  • Export the legacy PDP metafield values before deleting anything. For several the metafield holds the only copy of that copy.
  • Plan migrations for the surviving custom keys — the four accordion fields bound in templates/product.json, plus ingredient_metaobjects, faq_cluster, compare_product, as_featured_in.
  • Rebuild the dropped PDP sections as blocks, not delimited-string metafields.

Nice to have

Section titled “Nice to have”
  • Visual reference — Camden’s docs site uses Playwright to screenshot every section from the live site into an illustrated gallery (npm run capture). Genuinely useful for merchants, and worth porting once the section inventory settles.
  • “How do I…?” guides — task-oriented pages (add a product to the homepage, update the announcement bar) rather than reference-oriented ones.