Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the repository root README to prioritize the public @module-federation/astro package narrative (value proposition, beta status, and quick paths to try examples) instead of leading with repo/workspace implementation details.
Changes:
- Rewrites the README introduction to lead with
@module-federation/astroand adds a beta “IMPORTANT” callout directing users to GitHub Issues. - Adds an earlier “Example apps” section with host/remote ports and the
pnpm deventrypoint. - Moves repository-structure details into a dedicated “Repo layout” section near the bottom.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@module-federation/astroinstead of repo internalsWhy
The README opened with repository implementation details instead of the package value proposition. This makes the project harder to scan for users evaluating whether
@module-federation/astrosolves their problem.Impact
Users landing on the repo now see what the package is, what it supports, how to use it, and where to try it before they see workspace-specific implementation details.
Validation