Commit 94392be
Surface v10.1 supplemental packages from README and key docs (#1134)
### Summary
v10.1 added optional `shakapacker-webpack` and `shakapacker-rspack`
packages with a dedicated migration guide at
`docs/migration/v10.1-supplemental-packages.md`, but the guide was only
linked from `CHANGELOG.md` and `docs/dependency-strategy.md`. Users
arriving via `README.md`, `docs/installation.md`, or `docs/rspack.md`
would follow the old multi-dep install flow without ever learning the
supplemental packages exist. This PR adds cross-references from those
entry points plus `docs/common-upgrades.md` and the two peer-dependency
docs so the migration guide is discoverable. The guide content itself is
unchanged.
Files touched:
- `README.md` — added a v10.1 callout in the upgrade-links list
- `docs/installation.md` — added an "Optional: Consolidate dev
dependencies (10.1+)" subsection after "Run the Installer"
- `docs/rspack.md` — added a "Recommended (10.1+): `shakapacker-rspack`"
block at the top of Installation; kept the manual install as the
alternative for 10.0 and custom setups
- `docs/common-upgrades.md` — added an "Adopting Supplemental Packages
(10.1+)" top-level section + TOC entry
- `docs/peer-dependencies.md` and `docs/optional-peer-dependencies.md` —
added tips pointing at supplementals as an alternative to managing
individual peers
### Pull Request checklist
- ~[ ] Add/update test to cover these changes~ (docs-only)
- [x] Update documentation
- ~[ ] Update CHANGELOG file~ (per project rules, docs fixes don't get
CHANGELOG entries)
### Other Information
All link targets (`docs/migration/v10.1-supplemental-packages.md` and
the two `packages/shakapacker-*/README.md` files) verified to exist;
relative paths resolve correctly from each doc's location.
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Low Risk**
> Low risk docs-only change that adds cross-links and updated install
guidance; no runtime or dependency behavior changes.
>
> **Overview**
> **Improves discoverability of Shakapacker 10.1 supplemental
packages.** The README and several entry-point docs now call out
optional `shakapacker-webpack`/`shakapacker-rspack` packages and link to
the `v10.1 supplemental packages migration guide`.
>
> Installation/upgrade guidance is adjusted to present supplemental
packages as the recommended single-dependency path (with manual
multi-dependency install as an alternative) and adds a new `Common
Upgrades` section describing when to adopt (or avoid) these packages.
>
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
ef3df46. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent b6c26b2 commit 94392be
6 files changed
Lines changed: 78 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| 14 | + | |
14 | 15 | | |
15 | 16 | | |
16 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| |||
97 | 98 | | |
98 | 99 | | |
99 | 100 | | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
100 | 117 | | |
101 | 118 | | |
102 | 119 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
65 | 79 | | |
66 | 80 | | |
67 | 81 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
3 | 15 | | |
4 | 16 | | |
5 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
11 | 22 | | |
12 | 23 | | |
13 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
34 | 52 | | |
35 | 53 | | |
36 | | - | |
| 54 | + | |
37 | 55 | | |
38 | | - | |
| 56 | + | |
39 | 57 | | |
40 | | - | |
| 58 | + | |
41 | 59 | | |
42 | | - | |
| 60 | + | |
43 | 61 | | |
44 | 62 | | |
45 | 63 | | |
| |||
0 commit comments