fix(docs):resolve the guide TODOs for the plugin to its API references#163
Open
ryzrr wants to merge 4 commits into
Open
fix(docs):resolve the guide TODOs for the plugin to its API references#163ryzrr wants to merge 4 commits into
ryzrr wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates several guide pages to replace #TODO[...] placeholder links for plugin/API references with concrete /docs/api/v5.x/... documentation URLs, improving navigability from guides into the generated API docs.
Changes:
- Replaced placeholder links to
SplitChunksPlugin,ModuleConcatenationPlugin,ProvidePlugin,ContextReplacementPlugin,DefinePlugin, andModuleFederationPluginwith/docs/api/v5.x/...URLs. - Updated a few related references to
optimization.splitChunks/cacheGroupsto point at the API type documentation page used by the generated API docs.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pages/guides/optimization/tree-shaking.md | Replaces ModuleConcatenationPlugin TODO links with /docs/api/v5.x/optimize/ModuleConcatenationPlugin. |
| pages/guides/optimization/code-splitting/index.md | Replaces SplitChunksPlugin TODO links and updates optimization.splitChunks references to /docs/api/v5.x/.... |
| pages/guides/optimization/caching.md | Replaces SplitChunksPlugin TODO links and updates cacheGroups reference to /docs/api/v5.x/.... |
| pages/guides/modules-and-dependencies/shimming.md | Replaces ProvidePlugin TODO link with /docs/api/v5.x/plugins/ProvidePlugin. |
| pages/guides/modern-web/index.md | Replaces SplitChunksPlugin TODO link with /docs/api/v5.x/optimize/SplitChunksPlugin. |
| pages/guides/migration/to-v3.md | Replaces ContextReplacementPlugin / DefinePlugin TODO links with /docs/api/v5.x/plugins/.... |
| pages/guides/getting-started/concepts/under-the-hood.md | Replaces SplitChunksPlugin TODO links with /docs/api/v5.x/optimize/SplitChunksPlugin. |
| pages/guides/getting-started/concepts/module-federation.md | Replaces ModuleFederationPlugin TODO link with /docs/api/v5.x/container/ModuleFederationPlugin. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
moshams272
reviewed
Jul 3, 2026
avivkeller
reviewed
Jul 3, 2026
| ### `ModuleFederationPlugin` (high level) | ||
|
|
||
| [`ModuleFederationPlugin`](#TODO[/plugins/module-federation-plugin]) combines `ContainerPlugin` and `ContainerReferencePlugin`. | ||
| [`ModuleFederationPlugin`](/docs/api/v5.x/container/ModuleFederationPlugin) combines `ContainerPlugin` and `ContainerReferencePlugin`. |
Member
There was a problem hiding this comment.
Suggested change
| [`ModuleFederationPlugin`](/docs/api/v5.x/container/ModuleFederationPlugin) combines `ContainerPlugin` and `ContainerReferencePlugin`. | |
| [`ModuleFederationPlugin`](/docs/api/container/ModuleFederationPlugin) combines `ContainerPlugin` and `ContainerReferencePlugin`. |
Let's point to /, and then route / to whatever the latest version is
avivkeller
approved these changes
Jul 3, 2026
Member
Author
|
Should I keep the versioned links in this PR for now , and open a follow up PR that adds a redirect and then clean up all the links, does that works ? or should i edit in this one only |
Co-authored-by: Mohamed Shams El-Deen <68347231+moshams272@users.noreply.github.com>
ovflowd
approved these changes
Jul 4, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Issue - #158
Summary
Fixes some of the TODOs links
What kind of change does this PR introduce?
Fixing the Todos
Did you add tests for your changes?
No
Does this PR introduce a breaking change?
No
If relevant, what needs to be documented once your changes are merged or what have you already documented?
NA
Use of AI
Yes.