Skip to content

docs: clarify that remote-entries.json is user-produced (#51)#57

Merged
steven-pribilinskiy merged 1 commit into
mainfrom
docs/clarify-remote-entries-json
May 4, 2026
Merged

docs: clarify that remote-entries.json is user-produced (#51)#57
steven-pribilinskiy merged 1 commit into
mainfrom
docs/clarify-remote-entries-json

Conversation

@steven-pribilinskiy
Copy link
Copy Markdown
Collaborator

@steven-pribilinskiy steven-pribilinskiy commented Apr 30, 2026

Summary

Addresses #51. The README references remote-entries.json (and per-remote manifest files) without explaining where they come from, leading to confusion — the OP searched the web for it and found nothing because webpack and ModuleFederationPlugin do not generate these files. They are user-produced JSON files that teams publish alongside their builds.

This PR:

  • Adds an explicit note at the top of the Remote Manifest files section clarifying that the files are user-produced (not auto-generated), explaining their purpose, and noting that the filename is arbitrary.
  • Splits the existing format docs into clearly labeled Per-remote manifest format and Registry manifest format subsections.

No code changes.

Test plan

  • Render the README on GitHub and confirm the new note + subsection headings read clearly
  • Verify both example formats (per-remote and registry) still match what downloadRemoteEntryURLsFromManifests consumes ({ url } for per-remote, array of { scope, url } or { name: url } map for registry)

Add an explicit note that remote manifest files are NOT generated by
webpack or ModuleFederationPlugin — users must produce and host them
themselves alongside their builds. Split the per-remote vs registry
manifest formats into clearly labeled subsections.
Copy link
Copy Markdown

@unblocked unblocked Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No issues found

About Unblocked

Unblocked has been set up to automatically review your team's pull requests to identify genuine bugs and issues.

📖 Documentation — Learn more in our docs.

💬 Ask questions — Mention @unblocked to request a review or summary, or ask follow-up questions about your code.

👍 Give feedback — React to comments with 👍 or 👎 to help us improve.

⚙️ Customize — Adjust settings in your preferences.

@steven-pribilinskiy steven-pribilinskiy merged commit 8b5352c into main May 4, 2026
4 checks passed
@steven-pribilinskiy steven-pribilinskiy deleted the docs/clarify-remote-entries-json branch May 4, 2026 08:28
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