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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
smnandre opened this issue May 1, 2024 · 2 comments
Open

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

smnandre opened this issue May 1, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation Icons

Comments

@smnandre
Copy link
Collaborator

smnandre commented May 1, 2024

-- 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 :)

@carsonbot carsonbot added the Icons label May 1, 2024
@smnandre smnandre added the documentation Improvements or additions to documentation label May 1, 2024
@WebMamba
Copy link
Collaborator

WebMamba commented May 4, 2024

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

@smnandre
Copy link
Collaborator Author

smnandre commented May 5, 2024

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Icons
Projects
None yet
Development

No branches or pull requests

3 participants