Skip to content

Enhance Documentation for Custom Registry Usage #28

@dianannperla

Description

@dianannperla

Overview

While the current README provides a good introduction to setting up and using the RingCentral Micro Frontends framework, it lacks detailed instructions on how users can set up and use a custom registry for managing remote entry versions, which is mentioned as a feature in the documentation.

Suggested Improvements

I propose adding a dedicated section in the README that outlines the steps for configuring a custom registry, including:

  1. Setting Up the Custom Registry: Instructions or examples on how to create and configure a custom registry.
  2. Usage in site.config.js: A clear example of how to reference the custom registry in the site.config.js (or site.config.json) file, including sample configurations.
  3. Publishing to the Custom Registry: A brief guide on how to publish your micro frontends to the custom registry.
  4. Updating Dependencies: Information on how to handle version updates and dependency management using the custom registry.

Including this information would provide users with a clearer understanding of how to leverage this feature effectively, enhancing the overall usability of the framework.

Benefit

This enhancement will not only help new users to quickly implement a custom registry but will also improve the documentation's completeness, contributing to a better onboarding experience for developers.

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