Skip to content

Enhance Documentation: Add Example Usage for Component Overrides #524

@mowslasher83

Description

@mowslasher83

Proposed Enhancement

The current README provides a solid overview of the React SDK Components and how they interact with the @pega/react-sdk-overrides package. However, it would greatly benefit from the addition of example usage for overriding components.

Rationale

Providing examples of how to effectively override components would help users understand the process better and quicken their adoption of the SDK. This practical guidance could include:

  • A simple example that demonstrates how to create an override for a specific DX component.
  • Instructions on how to set up and configure the override within their project.
  • Common pitfalls to avoid when overriding components.

Suggested Location

This section could be added under the Packages in this repo section, specifically after the description of the react-sdk-overrides package.

Benefits

  • Improved onboarding experience for new users.
  • Reduced confusion and support queries related to component overrides.

Thank you for considering this enhancement!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions