Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[React] Mention Webpack Encoure bundle should be installed first #2523

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from
+2 −0
Open

[React] Mention Webpack Encoure bundle should be installed first #2523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/React/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

Totally, a simple sentence is enough, no need to duplicate what's written on Webpack Encore setup page.

Copy link
Member

Choose a reason for hiding this comment

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

@dukeofgaming still motivated on releasing this doc update?

Copy link
Author

Choose a reason for hiding this comment

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

@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

Copy link
Author

Choose a reason for hiding this comment

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

@smnandre totally ok with your change :)


.. note::

Expand Down Expand Up @@ -156,3 +157,4 @@ https://symfony.com/doc/current/contributing/code/bc.html
.. _`Symfony UX initiative`: https://ux.symfony.com/
.. _`Symfony UX React demo`: https://ux.symfony.com/react
.. _`Turbo`: https://turbo.hotwire.dev/
.. _`Symfony Encore bundle`: https://symfony.com/doc/current/frontend/encore/installation.html
Loading