Skip to content

chore: better README on the Astro package#7

Merged
Nsttt merged 2 commits intomainfrom
codex/readme-beta-feedback-callout
Apr 9, 2026
Merged

chore: better README on the Astro package#7
Nsttt merged 2 commits intomainfrom
codex/readme-beta-feedback-callout

Conversation

@Nsttt
Copy link
Copy Markdown
Member

@Nsttt Nsttt commented Apr 9, 2026

Summary

  • add a beta callout that asks users to file feedback and bugs via GitHub Issues
  • rewrite the top of the README to lead with @module-federation/astro instead of repo internals
  • surface the example apps earlier and move repo structure details lower in the document

Why

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/astro solves 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

  • reviewed rendered Markdown structure locally
  • no code or runtime changes
  • no tests run

@Nsttt Nsttt changed the title [codex] Refocus README on the Astro package chore: better README on the Astro package Apr 9, 2026
@Nsttt Nsttt self-assigned this Apr 9, 2026
@Nsttt Nsttt marked this pull request as ready for review April 9, 2026 16:21
Copilot AI review requested due to automatic review settings April 9, 2026 16:21
@Nsttt Nsttt merged commit 3c0c7db into main Apr 9, 2026
2 of 3 checks passed
Copy link
Copy Markdown

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 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/astro and adds a beta “IMPORTANT” callout directing users to GitHub Issues.
  • Adds an earlier “Example apps” section with host/remote ports and the pnpm dev entrypoint.
  • 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.

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.

2 participants