[React] Mention Webpack Encoure bundle should be installed first #2523
Conversation
…led first If not working with AssetManager. This will help newcomers not have to remove the UX React bundle if they wanted it to modify what is created through the Webpack Encore bundle.
carsonbot
added
Bug
dukeofgaming
changed the title
| @@ -14,6 +14,7 @@ Symfony UX React supports React 18+. | |||
|
|
|||
| Installation | |||
| ------------ | |||
| Make sure you have WebpackEncore if you are not working with AssetMapper. You can install and configure Webpack Encore through the `Symfony Encore bundle`_. This will modify your ``base.html.twig`` template and create ``assets/app.js``, in addition to adding and modifying other configuration, which will in turn help you get started faster with the UX React bundle. | |||
There was a problem hiding this comment.
There is a note just below, stating "works best with Webpack Encore. If AssetMapper... "
I'd rather keep it on top. I think we should add a simple sentence here, with a link to either the WebpackEncore documentation, or a section lower in the page.
Something like
. note::
This package works best with WebpackEncore (see :ref:`Install and configure WebpackEncore`_)
To use it with AssetMapper, see :ref:`Using with AssetMapper <using-with-asset-mapper>`. That would make this visible, while keeping the top of the page focused on ux/react
There was a problem hiding this comment.
Totally, a simple sentence is enough, no need to duplicate what's written on Webpack Encore setup page.
There was a problem hiding this comment.
@dukeofgaming still motivated on releasing this doc update?
There was a problem hiding this comment.
@smnandre will try to get back to this by the end of the week. I recall this causing me some unnecessary pain (had to revert a commit on installing the UX react bundle). just because I had not configured/installed webpack before following the docs on the installation of the UX React bundle
There was a problem hiding this comment.
@smnandre totally ok with your change :)
smnandre
changed the title
smnandre
added
Status: Reviewing
smnandre
added
Status: Needs Work
If not working with AssetMapper.
This will help newcomers not have to remove the UX React bundle if they wanted it to modify what is created through the Webpack Encore bundle.