Storefront template docs: close documentation gaps#11
Open
next-devin wants to merge 1 commit intomainfrom
Open
Storefront template docs: close documentation gaps#11next-devin wants to merge 1 commit intomainfrom
next-devin wants to merge 1 commit intomainfrom
Conversation
Addresses gaps in template tags, objects, filters, and URL references for theme development. Changes include: Tags: cart_form, core_js, add_query_param, render_field, annotate_form_field, purchase_info_for_line Objects: cart, line, session, variant_form, filters (faceting), subscription_group, user, cart template context variables Filters: currency (price formatting), split URLs: homepage, cart actions, customer/auth, localization endpoints, GraphQL API endpoint, typo fix (support:category-list) Structural: per-template context table showing what variables each view provides, dashboard cross-reference table mapping template variables to their dashboard configuration paths Fixes: broken /docs/storefront/api link, filters.md missing from meta.json sidebar Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive update to storefront template documentation addressing gaps identified through a systematic audit. The existing docs covered ~40% of the template API surface area actually used by themes — this PR closes the critical gaps so a developer can build a functional theme from the docs alone.
Tags added (6)
cart_form— generates add-to-cart forms (every product page needs this)core_js— platform core JS bundle (every theme needs this)add_query_param— pagination and filter URL buildingrender_field/annotate_form_field— form rendering helperspurchase_info_for_line— cart line pricing (complements existingpurchase_info_for_product)Objects added (7)
cart— shopping cart with all properties (totals, taxes, discounts, subscriptions)line— cart line items (price, quantity, discounts)session— the object returned bypurchase_info_for_product(price + availability)variant_form— product variant selectionfilters— category page faceting (price_range, boolean, list types)subscription_group— subscription cart groupingsuser— authentication stateFilters added (2)
currency— price formatting (used on every price display, was completely undocumented)split— string splittingURLs added
templates/index.html)cart:add,cart:saved,cart:vouchers-add,cart:vouchers-remove)customer:login,customer:logout,customer:summary,customer:support-ticket-create)set_language,core:set-currency,core:set-storefront)storefrontapi:graphql)Structural improvements
Fixes
/docs/storefront/api→/docs/storefront/graphqlin cdn-and-caching.mdxsupport:cateogry-list→support:category-listfilters.mdadded tometa.jsonpages array (was missing from sidebar)Review notes
All additions are based on actual usage patterns extracted from the Intro Bootstrap theme. Property tables, types, and descriptions reflect what templates actually consume. Code examples are copy-pasteable and follow existing doc conventions.
The gap analysis document (
STOREFRONT_DOCS_GAP_ANALYSIS.md) is NOT included in this PR — it was used as the working plan and remains local only.Test plan
npm run dev) with no errors🤖 Generated with Claude Code