docs: remove deprecated devServer.inline references from HMR guide#2479
docs: remove deprecated devServer.inline references from HMR guide#2479
Conversation
- Remove all references to devServer.inline which no longer exists in webpack 5 - Update configuration examples to only show hmr setting - Simplify error messages section Fixes #1682 Co-authored-by: Justin Gordon <justin808@users.noreply.github.com>
WalkthroughThe documentation guide for HMR and hot reloading is updated to remove all references to the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR removes deprecated Changes made:
Confidence Score: 5/5
Important Files Changed
Last reviewed commit: 6bfdfa3 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (1)
45-54: Minor phrasing nit on line 45.After dropping
and \inline`, the instruction reads: *"sethmrdev_server` property to true"* — two backtick-wrapped identifiers appear back-to-back without connecting prose, which is slightly confusing.✏️ Suggested rewording
-1. In `config/shakapacker.yml` set `hmr` `dev_server` property to true. +1. In `config/shakapacker.yml`, set the `hmr` property under `dev_server` to `true`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md` around lines 45 - 54, The phrase "set `hmr` `dev_server` property to true" is confusing because two backticked identifiers are adjacent; update the wording to a clear form such as "set the `hmr` property in `dev_server` to true" (or "set the `dev_server` `hmr` property to true") so it unambiguously references the `hmr` property within `dev_server`.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md`:
- Around line 45-54: The phrase "set `hmr` `dev_server` property to true" is
confusing because two backticked identifiers are adjacent; update the wording to
a clear form such as "set the `hmr` property in `dev_server` to true" (or "set
the `dev_server` `hmr` property to true") so it unambiguously references the
`hmr` property within `dev_server`.
Summary
Closes #1682
Note
Low Risk
Documentation-only change that updates configuration guidance; no runtime behavior or APIs are modified.
Overview
Updates the HMR guide to remove deprecated
devServer.inline/dev_server.inlineguidance and references, and rewrites the related instructions/error examples to talk only aboutdev_server.hmr.The config snippets and fallback advice are adjusted accordingly (set only
hmr: truefor client-side HMR; ensurehmris false when usingwebpack-dev-serverfor both client/server bundles).Written by Cursor Bugbot for commit 6bfdfa3. Configure here.
Summary by CodeRabbit