docs: Overhaul README and point to the documentation website - #142
Merged
Merged
Conversation
Trim the README to an overview and link to native-federation.com for the config reference, tutorial and FAQ. Drop MIGRATION_GUIDE.md in favour of the migration page on the docs site, and set homepage and bugs in package.json so npm links to the docs and the issue tracker.
Aukevanoost
added a commit
that referenced
this pull request
Sep 24, 2026
Backports 22.1.3..22.2.0 onto the Angular 21 layout. Incoming: - #138: each federation build context gets its own generated tsconfig (write-context-tsconfig) instead of rewriting `files` in tsconfig.federation.json, and every mapping/exposed context is disposed before the app build. init no longer writes `files`; the new update22-2 migration removes it from existing tsconfig.federation.json files. - #143: builder accepts a `define` option, merged over the Angular target's define for exposed modules and passed through to the dev server (createInternalAngularBuilder moved to internal-angular-builder.ts). - #141: config types exported, shared builders accepted without get(), init generates the shared config with fromPackageJson and patches @angular/core. - #142: README overhaul pointing to the documentation website; MIGRATION_GUIDE.md removed in favour of the website's migration guide. - @softarc/native-federation ~4.7.0, jsonc-parser added, json5 dropped. Angular 21 specific adaptations: - Layout: write-context-tsconfig lands in src/utils/ next to the bundler; src/utils/update-federation-tsconfig.* is removed as on main. Comment pointers to tools/esbuild/ respelled to utils/. - Skipped d535e07 (Angular 22.2 upgrade): node-modules-bundler keeps the 21.2 JavaScriptTransformer/Cache signatures, and federation-source-files keeps reading SourceFileCache.keys(), which is still a Map on 21.2. - internal-angular-builder drops instrumentForCoverage, which this branch never carried; it only forwards define. - Restores the pre-app-build dispose (#47) that the earlier main merge (d00b9fc) dropped, now as disposeFederationContexts() per #138. - update22-2 keeps main's path and key for easier future merges, versioned 21.2.13 so it runs when updating the -v4 package. - README respelled for -v4 (badges, install, init, config import, ng update) with the version example set to 21.2.x. - Kept deleted as before: update22 schematic, share-utils.spec.ts and tools/esbuild/angular-esbuild-adapter.spec.ts. - Kept the ng21 pins, -v4 package name, 21.2.12 version and the TS 5.9 / eslint 9 toolchain; took only the core bump and jsonc-parser from main.
Merged
2 tasks
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
1 participant
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
The README had grown into a 905-line config reference and tutorial that duplicated (and drifted from) native-federation.com. This trims it to an overview (~100 lines) and links to the docs site for everything else, with the same layout as the core README in native-federation/native-federation-core#151.
README now contains
ng update, and the v3 sourcenative-federationfor Angular 22+,native-federation-v4for Angular 20–21)initcommands and thefederation.config.mjsthe schematic generatesllms.txt, contributing, credits and licenseMoved to the docs site (no longer in the README)
denseChunking,denseExternals,autoShareScope,fromPackageJson, shared mappings)npm link/watchLinkedDeps, the NxɵɵdefineComponentFAQ and the custom builder examplesRemoved
MIGRATION_GUIDE.md, in favour of the migration page on the docs sitepackage.json
homepagenow points to the Angular adapter docs, andbugsis added, so npmjs.com links to the docs and the issue trackerTest plan
prettier --checkpasses on README.md