Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 1, 2025

Enhanced the README component documentation by adding HTML tag names as the second column in both component summary tables. This makes it easier for developers to understand the mapping between component class names and their corresponding custom element tags.

Changes:

  • Store level templating table: Added tag names for Campaign (nosto-campaign), SectionCampaign (nosto-section-campaign), and Control (nosto-control)
  • Campaign level templating table: Added tag names for DynamicCard (nosto-dynamic-card), Image (nosto-image), Product (nosto-product), ProductCard (nosto-product-card), and SkuOptions (nosto-sku-options)

Before:

| Component | Description |
| --------- | ----------- |
| Campaign  | Campaign rendering and product recommendation display |

After:

| Component | Tag Name         | Description |
| --------- | ---------------- | ----------- |
| Campaign  | `nosto-campaign` | Campaign rendering and product recommendation display |

All tag names were verified against the actual @customElement decorators in the source code to ensure accuracy. The tag names are formatted with code blocks (backticks) for better visual distinction.

Fixes #295.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Copilot AI changed the title [WIP] Augment the README summary table with tag names docs: add tag names as second column in README component tables Sep 1, 2025
Copilot AI requested a review from timowestnosto September 1, 2025 09:49
Copilot finished work on behalf of timowestnosto September 1, 2025 09:49
@timowestnosto timowestnosto marked this pull request as ready for review September 1, 2025 11:35
Copilot AI review requested due to automatic review settings September 1, 2025 11:35
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the README documentation by adding HTML tag names as a second column in both component summary tables, making it easier for developers to understand the mapping between component class names and their corresponding custom element tags.

Key changes:

  • Added "Tag Name" column to both store-level and campaign-level component tables
  • Included proper HTML custom element tag names for all 8 components
  • Formatted tag names with code blocks for better visual distinction

@timowestnosto timowestnosto merged commit d2ca5a9 into main Sep 2, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Augment the README summary table with tag names

3 participants