[Icons] Docs: Merging code blocks; language improvements #2793
Conversation
| HTTP Client for On-Demand Icons | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If you plan to use provided icon sets, make sure that you have the HTTP client installed: | ||
|
|
||
| .. code-block:: terminal | ||
|
|
||
| $ composer require symfony/http-client |
There was a problem hiding this comment.
Please do not remove this. It has been discussed already, and this information is usefull.
There was a problem hiding this comment.
I didn't remove it, I just moved it upwards.
There was a problem hiding this comment.
Given that we have improved the DX here, I'm ok removing this as a "doc section". Maybe a tip or note admonition though so it's still obvious?
There was a problem hiding this comment.
Well, it's in the very first code block on the page :-)
What would you suggest?
There was a problem hiding this comment.
A tip just below the composer require symfony/ux-icons code block.
There was a problem hiding this comment.
Probably a second tip about installing ux-twig-component that links to a single html-syntax section as proposed in #2795 (review)
|
I really don’t want to clutter the installation instructions for users who just want to display icons. That’s in line with how many Symfony docs are written:
This first install block needs to stay short and intuitive. Adding lines that aren't strictly necessary for most users just adds noise. That said, I’m totally open to making the rest better.. (optional dependencies and/or how we explain the HTML syntax) My personal take would be to have a separate “HTML Syntax” section with a code sample and a composer require, and then point to it when relevant. Same thing for the HTTP client. But placing all of that right after “install” and before showing how it actually works still feels too soon to me. |
carsonbot
added
Status: Reviewed
|
I see that you have strong opinions. So just take what you think is useful, and close/delete the rest. |
|
We're always open to improvements Recent suggestions felt a bit mixed --some very valid points, others less aligned with concrete user needs or going against points we've already covered. Thanks again for your time and input! |
Page: https://symfony.com/bundles/ux-icons/current/index.html#installation