Skip to content

COMDOX-1681: Rewrite product-details merchant page for authors#903

Open
bdenham wants to merge 3 commits into
releasefrom
comdox-1681-author-blocks
Open

COMDOX-1681: Rewrite product-details merchant page for authors#903
bdenham wants to merge 3 commits into
releasefrom
comdox-1681-author-blocks

Conversation

@bdenham
Copy link
Copy Markdown
Collaborator

@bdenham bdenham commented May 27, 2026

Summary

Rewrites the product-details merchant block page from a 72-line stub into a beginner-friendly author guide. The new page explains where the block already lives in the default boilerplate, what shoppers see, when to use it, the common authoring tasks an author can do without code, the corrected default-sku configuration, and where to hand off to a developer. It serves as the pilot template for the rest of the B2C and B2B merchant block pages tracked by COMDOX-1681.

Changes

  • Replace the short intro with a description that names the block, lists what it renders, and tells authors which audience this page is written for.
  • Add "Where this block lives in your default boilerplate" so authors understand they edit /products/default rather than adding the block from scratch.
  • Add "What shoppers see" with a list of UI regions and cross-links to the developer container pages under /dropins/product-details/.
  • Add "When to use this block" covering the standard PDP, marketing pages, and multiple instances on one page.
  • Add "Common authoring tasks" with <Steps> for previewing the template page, featuring a specific product, setting the SKU through page metadata, adjusting section styling, and adding related blocks.
  • Correct the Configuration section for default-sku, including the SKU resolution chain in scripts/commerce.js and the itemUid / optionsUIDs URL parameters consumed by the block.
  • Add "Customize beyond authoring" with links into the drop-in overview, containers, slots, events, and tutorials so the page hands off cleanly to developer docs.
  • Add "Verify and publish" steps and a short "Common failure modes" list for troubleshooting.

Testing

  • Manual review against the project's beginner-audience, writing-style, and no-bold rules.
  • Internal links resolve to existing pages in this repo (/dropins/product-details/containers/*, /merchants/blocks/b2b/, /dropins/product-details/).
  • default-sku behavior verified against the live boilerplate (scripts/commerce.js and blocks/product-details/product-details.js on hlxsites/aem-boilerplate-commerce main).

JIRA

COMDOX-1681

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@bdenham bdenham self-assigned this May 27, 2026
@bdenham bdenham added the major-update Significant original updates to existing content label May 27, 2026
Adds a shared author-facing page that explains the actual placeholders
workflow (DA.live sheet, preview-and-publish on the sheet itself, JSON
URL verification, hard refresh). The PDP page now links to it instead
of restating wrong instructions inline, and the duplicate inline
Section metadata table is replaced by a link to the existing shared
guide so the pattern scales to the other block pages.

Co-authored-by: Cursor <cursoragent@cursor.com>
The file and its sidebar entry now live exclusively on
comdox-1681-authoring-overview (PR #904), which is the
canonical home for that content. This eliminates any
potential merge conflict when both PRs land on release.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

major-update Significant original updates to existing content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant