Skip to content

docs: remove deprecated devServer.inline references from HMR guide#2479

Open
justin808 wants to merge 1 commit intomasterfrom
claude/issue-1682-20250924-2356
Open

docs: remove deprecated devServer.inline references from HMR guide#2479
justin808 wants to merge 1 commit intomasterfrom
claude/issue-1682-20250924-2356

Conversation

@justin808
Copy link
Member

@justin808 justin808 commented Feb 23, 2026

Summary

  • remove stale devServer.inline guidance from HMR docs
  • align docs with current webpack-dev-server behavior

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.inline guidance and references, and rewrites the related instructions/error examples to talk only about dev_server.hmr.

The config snippets and fallback advice are adjusted accordingly (set only hmr: true for client-side HMR; ensure hmr is false when using webpack-dev-server for both client/server bundles).

Written by Cursor Bugbot for commit 6bfdfa3. Configure here.

Summary by CodeRabbit

  • Documentation
    • Simplified webpack dev server hot module reloading configuration documentation by streamlining setup instructions and removing deprecated configuration option references.
    • Updated error scenarios, context explanations, and troubleshooting recommendations to align with current HMR configuration practices.

- 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>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 23, 2026

Walkthrough

The documentation guide for HMR and hot reloading is updated to remove all references to the dev_server.inline configuration option, which no longer exists. Configuration instructions now focus solely on the hmr setting, and error cases related to inline configuration are removed.

Changes

Cohort / File(s) Summary
HMR Documentation Update
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
Removed all references to dev_server.inline configuration. Removed associated error case, updated configuration examples to only require hmr property, and simplified troubleshooting guidance to exclude inline-related suggestions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hop along, old config so worn,
inline whispers fade like autumn corn,
HMR shines bright, now clear and true,
The path ahead is fresh and new! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: removing deprecated devServer.inline references from HMR documentation, which aligns with the actual file changes.
Linked Issues check ✅ Passed The PR successfully addresses issue #1682 by removing all devServer.inline references and updating HMR documentation to reflect current webpack-dev-server options.
Out of Scope Changes check ✅ Passed All changes are scoped to updating the HMR documentation file to remove deprecated devServer.inline references, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch claude/issue-1682-20250924-2356

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link

greptile-apps bot commented Feb 23, 2026

Greptile Summary

This PR removes deprecated devServer.inline configuration references from the HMR documentation. The changes align the guide with current webpack-dev-server behavior where the inline option has been removed in recent versions.

Changes made:

  • Removed all mentions of dev_server.inline / devServer.inline configuration
  • Removed the related error example: TypeError: Cannot read property 'prototype' of undefined
  • Updated YAML configuration example to only show hmr: true
  • Updated fallback advice to reference only hmr setting
  • Simplified server-side rendering error guidance to only mention HMR configuration

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only change that removes deprecated configuration references; no code changes, no runtime impact, and aligns with current webpack-dev-server behavior
  • No files require special attention

Important Files Changed

Filename Overview
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md Removes deprecated devServer.inline references and updates HMR configuration guidance to align with current webpack-dev-server behavior

Last reviewed commit: 6bfdfa3

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 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: *"set hmr dev_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`.

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.

Update HMR docs

1 participant