Skip to content

Commit 86ba8ab

Browse files
committed
linking to new UX section
1 parent fb05d24 commit 86ba8ab

File tree

8 files changed

+26
-18
lines changed

8 files changed

+26
-18
lines changed

src/Chartjs/Resources/doc/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ It is part of `the Symfony UX initiative`_.
88
Installation
99
------------
1010

11-
Symfony UX Chart.js requires PHP 7.2+ and Symfony 4.4+.
11+
Before you start, make sure you have `Symfony UX configured in your app`_.
1212

13-
Install this bundle using Composer and Symfony Flex:
13+
Then, install this bundle using Composer and Symfony Flex:
1414

1515
.. code-block:: terminal
1616
@@ -157,3 +157,4 @@ bound to Symfony's BC policy for the moment.
157157
.. _`Chart.js documentation`: https://www.chartjs.org/docs/latest/
158158
.. _`Symfony Webpack Encore`: https://symfony.com/doc/current/frontend/encore/installation.html
159159
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
160+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/Cropperjs/Resources/doc/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Symfony UX Cropper.js is a Symfony bundle integrating the
88
Installation
99
------------
1010

11-
Symfony UX Cropper.js requires PHP 7.2+ and Symfony 4.4+.
11+
Before you start, make sure you have `Symfony UX configured in your app`_.
1212

13-
Install this bundle using Composer and Symfony Flex:
13+
Then, install this bundle using Composer and Symfony Flex:
1414

1515
.. code-block:: terminal
1616
@@ -152,3 +152,4 @@ meaning it is not bound to Symfony’s BC policy for the moment.
152152
.. _`@symfony/stimulus-bridge`: https://github.com/symfony/stimulus-bridge
153153
.. _`the Cropper.js options`: https://github.com/fengyuanchen/cropperjs/blob/main/README.md#options
154154
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
155+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/Dropzone/Resources/doc/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ having to browse their computer for a file.
1010
Installation
1111
------------
1212

13-
Symfony UX Dropzone requires PHP 7.2+ and Symfony 4.4+.
13+
Before you start, make sure you have `Symfony UX configured in your app`_.
1414

15-
Install this bundle using Composer and Symfony Flex:
15+
Then, install this bundle using Composer and Symfony Flex:
1616

1717
.. code-block:: terminal
1818
@@ -155,3 +155,4 @@ bound to Symfony’s BC policy for the moment.
155155
.. _`the Symfony UX initiative`: https://symfony.com/ux
156156
.. _`@symfony/stimulus-bridge`: https://github.com/symfony/stimulus-bridge
157157
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
158+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/LazyImage/Resources/doc/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ It provides two key features:
1212
Installation
1313
------------
1414

15-
Symfony UX LazyImage requires PHP 7.2+ and Symfony 4.4+.
15+
Before you start, make sure you have `Symfony UX configured in your app`_.
1616

17-
You can install this bundle using Composer and Symfony Flex:
17+
Then install this bundle using Composer and Symfony Flex:
1818

1919
.. code-block:: terminal
2020
@@ -172,3 +172,4 @@ meaning it is not bound to Symfony’s BC policy for the moment.
172172
.. _`BlurHash implementation`: https://blurha.sh
173173
.. _`WebpackEncoreBundle v1.10`: https://github.com/symfony/webpack-encore-bundle
174174
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
175+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/LiveComponent/src/Resources/doc/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ Want a demo? Check out https://github.com/weaverryan/live-demo.
6464
Installation
6565
------------
6666

67-
Let's get started! Install the library with:
67+
Before you start, make sure you have `Symfony UX configured in your app`_.
68+
69+
Now install the library with:
6870

6971
.. code-block:: terminal
7072
@@ -1444,3 +1446,4 @@ bound to Symfony's BC policy for the moment.
14441446
.. _`Symfony form`: https://symfony.com/doc/current/forms.html
14451447
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
14461448
.. _`dependent form fields`: https://symfony.com/doc/current/form/dynamic_form_modification.html#dynamic-generation-for-submitted-forms
1449+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/Swup/Resources/doc/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ bringing the complexity of a React/Vue/Angular application.
1212
Installation
1313
------------
1414

15-
Symfony UX Swup does not use any PHP and can be installed with any
16-
PHP/Symfony version.
15+
Before you start, make sure you have `Symfony UX configured in your app`_.
1716

18-
You can install this bundle using Composer and Symfony Flex:
17+
Then install the bundle using Composer and Symfony Flex:
1918

2019
.. code-block:: terminal
2120
@@ -203,3 +202,4 @@ meaning it is not bound to Symfony's BC policy for the moment.
203202
.. _`WebpackEncoreBundle v1.10`: https://github.com/symfony/webpack-encore-bundle
204203
.. _`Swup Options`: https://swup.js.org/options
205204
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
205+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/Turbo/Resources/doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Or watch the `Turbo Screencast on SymfonyCasts`_.
1818
Installation
1919
------------
2020

21-
Symfony UX Turbo requires PHP 7.2+ and Symfony 5.2+.
21+
Before you start, make sure you have `Symfony UX configured in your app`_.
2222

2323
Install this bundle using Composer and Symfony Flex:
2424

@@ -829,3 +829,4 @@ meaning it is not bound to Symfony's BC policy for the moment.
829829
.. _`Kévin Dunglas`: https://dunglas.fr
830830
.. _`hotwired/turbo-rails`: https://github.com/hotwired/turbo-rails
831831
.. _`sroze/live-twig`: https://github.com/sroze/live-twig
832+
.. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html

src/TwigComponent/src/Resources/doc/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Twig Components
55
to change, or even change drastically.
66

77
Twig components give you the power to bind an object to a template,
8-
making it easier to render and re-use small template units - like an
9-
alert, markup for a modal, or a category sidebar:
8+
making it easier to render and re-use small template "units" - like an
9+
"alert", markup for a modal, or a category sidebar:
1010

1111
Every component consists of (1) a class::
1212

@@ -44,7 +44,7 @@ Enjoy your new component!
4444

4545
Example of the AlertComponent
4646

47-
This brings the familiar component system from client-side frameworks
47+
This brings the familiar "component" system from client-side frameworks
4848
into Symfony. Combine this with `Live Components`_, to create
4949
an interactive frontend with automatic, Ajax-powered rendering.
5050

@@ -64,7 +64,7 @@ That's it! We're ready to go!
6464
Creating a Basic Component
6565
--------------------------
6666

67-
Let's create a reusable alert element that we can use to show success
67+
Let's create a reusable "alert" element that we can use to show success
6868
or error messages across our site. Step 1 is always to create a
6969
component that has an ``AsTwigComponent`` class attribute. Let's start
7070
as simple as possible::
@@ -257,7 +257,7 @@ component use a ``PreMount`` hook::
257257
Fetching Services
258258
-----------------
259259

260-
Let's create a more complex example: a featured products component.
260+
Let's create a more complex example: a "featured products" component.
261261
You *could* choose to pass an array of Product objects into the
262262
``component()`` function and set those on a ``$products`` property. But
263263
instead, let's allow the component to do the work of executing the

0 commit comments

Comments
 (0)