symfony / ux

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

[Icons] Documentation "structure" (H2/3/..) #1818

Open smnandre opened 6 months ago

smnandre commented 6 months ago

-- STRUCTURE ONLY - NOT THAT BIG AN ISSUE 👼 --

The curent UX Icons documentation seems a bit odd to me due to its structure.

I suggest some mid changes (mainly move things or renaming sections or changing the "depth" of some)

First part

Currernt

Table of Contents/
|-- Installation
|-- SVG Icons/
|   `-- Icon Names
|-- Loading Icons/
|   |-- Icon Sets
|   |-- Search Icon sets
|   |-- Search Icons
|   `-- HTML Syntax
|-- Downloading

Suggested

Table of Contents/
|-- Installation
|-- Basic usage
|-- SVG Icons/
|   |-- Icons
|   `-- Icon Names
|   |-- Icon Sets
|   `-- Icon Sets Names
|-- Downloading Icons/

Second part

Currernt

Table of Contents/
|-- Installation
|-- SVG Icons/
|   `-- Icon Names
|-- Loading Icons/
|   |-- Icon Sets
|   |-- Search Icon sets
|   |-- Search Icons
|   `-- HTML Syntax
|-- Downloading Icons/
|   |-- Local SVG Icons
|   `-- Icons On-Demand
|-- Importing Icons/
|   `-- Locking On-Demand Icons
|-- Rendering Icons/
|   |-- HTML Syntax
|   `-- Default Attributes
|-- Accessibility

Siggested:

|-- Loading Icons/
|   |-- Local SVG Icons
|   `-- Imported Icons
|   `-- On-Demand icons
|-- Rendering Icons/
|   |-- Twig Function
|   |-- HTML Syntax
|   `-- Render Attributes
|   `-- Default Attributes
|   `--Accessibility

Last part

Current:

|   `-- Default Attributes
|-- Accessibility
|-- Performance
|-- Caching/
|   |-- Icon Caching
|   `-- TwigComponent
|-- Configuration/
|   |-- Debugging Configuration

Suggested:

|   `-- Default Attributes
|   `--  Accessibility
|-- Performance
|   |-- Caching
|   |-- Icon Storage
|   `-- Twig Optimization
|-- Configuration/
|   |-- Debugging Configuration

Open to any feedback and if that's ok for you i'll open a PR :)

WebMamba commented 6 months ago

You have the Accessibility on the second and last part is it in purpose? Sound good to me 👍

smnandre commented 6 months ago

Just to show the surroundings / give context :)

The main idea beeing: i think "Accessiiblity" should be inside the "Rendering" section (contrary to the root level it is today)

carsonbot commented 2 days ago

Thank you for this issue. There has not been a lot of activity here for a while. Has this been resolved?