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.

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

[UX] Centralizing docs around StimulusBundle #18381

Merged
merged 1 commit into from Jun 15, 2023

Conversation

weaverryan
Copy link
Member

Hi!

This goes with symfony/ux#930

Basically, now that StimulusBundle exists, it is the "heart" of UX: installing it activates Stimulus in your app + integration with the UX packages. And so, I've shortened this document and moved most of the instructions into StimulusBundle instead.

Let me know your thoughts.

Thanks!

@javiereguiluz
Copy link
Member

I like the simplification. Thanks for that!

But we tend to avoid super short documents ... and this one is now 54-line long. Maybe it's too short? Would it make sense to combine it with some other article? Moreover, there are many concepts floating around front-end: Stimulus, UX, AssetMapper, Webpack Encore, etc. So, having many small documents could be confusing to readers. Thanks.

@@ -480,7 +478,8 @@ Encore supports many more features! For a full list of what you can do, see
.. _`WebpackEncoreBundle Configuration`: https://github.com/symfony/webpack-encore-bundle#configuration
.. _`Stimulus`: https://stimulus.hotwired.dev/
.. _`Stimulus Documentation`: https://stimulus.hotwired.dev/handbook/introduction
.. _`Symfony Stimulus Bridge`: https://github.com/symfony/stimulus-bridge
.. _StimulusBundle & the UX System: https://symfony.com/bundles/StimulusBundle/current/index.html
.. _all the Symfony UX packages: https://symfony.com/bundles/StimulusBundle/current/index.html#ux-packages
Copy link
Member Author

Choose a reason for hiding this comment

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

Whenever StimulusBundle docs build next, this should be there. It's from symfony/ux#930

@weaverryan
Copy link
Member Author

Ready to go - I agree on removing the UX page entirely... I was also pondering that. It's done now - with a redirection to the StimulusBundle docs.

@javiereguiluz
Copy link
Member

Thank you Ryan.

@javiereguiluz javiereguiluz merged commit 9ae5140 into symfony:6.3 Jun 15, 2023
@weaverryan weaverryan deleted the ux-docs-stimulus-bundle branch June 15, 2023 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants