Add documentation for the sdc_examples_replacements submodule

Created on 4 November 2023, about 1 year ago
Updated 6 November 2023, about 1 year ago

Problem/Motivation

Hi. First of all, this is a great module, thank you for it!

I notice there's an sdc_examples_replacements submodule, and I'd like to understand what it's intended to demonstrate. It has its own version of a my-button--primary component (in addition to the component of the same name in the main module). Is the intended functionality that any place that references the my-button--primary component gets this one instead of the main one? Or is the intended functionality that theme templates and/or SDC Display can choose which module's my-button--primary component to render?

Steps to reproduce

Proposed resolution

Add some docs to explain this (or link to existing docs if that's already been explained elsewhere).

Remaining tasks

User interface changes

API changes

Data model changes

πŸ“Œ Task
Status

Active

Version

1.0

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States effulgentsia

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @effulgentsia
  • πŸ‡ΊπŸ‡ΈUnited States effulgentsia

    Is the intended functionality that any place that references the my-button--primary component gets this one instead of the main one?

    Oh I see. I think the answer is yes because in its my-button--primary.component.yml file, it says replaces: 'sdc_examples:my-button--primary'.

    Leaving this issue open because I think adding a README to this submodule (or adding info about this submodule to the main module's README) would still be helpful.

Production build 0.71.5 2024