symfony / ux

Symfony UX initiative: a JavaScript ecosystem for Symfony
https://ux.symfony.com/
MIT License
850 stars 313 forks source link

[UX] Add description to attributes and their parameters #1172

Open smnandre opened 1 year ago

smnandre commented 1 year ago

There is an ongoing work started by @GromNaN to add documentation on attribute classes + parameters across Symfony codebase.

Here's what it would like in symfony/ux

(some are already well documented)

Meta-issue: https://github.com/symfony/symfony/issues/51920

weaverryan commented 1 year ago

Great idea! If you're reading this, please feel free to grab an attribute, describe it a bit, and open a PR. We can help during review with any phrasing - so it doesn't need to be perfect.

smnandre commented 1 year ago

I started one (https://github.com/symfony/ux/pull/1229), please tell me if that's going in the good direction (style, content..) and i'll continue :)