diff --git a/docs/contribute/icons/metadata-conventions/tag-guide.md b/docs/contribute/icons/metadata-conventions/tag-guide.md index 1bd5186da..fd7b026ce 100644 --- a/docs/contribute/icons/metadata-conventions/tag-guide.md +++ b/docs/contribute/icons/metadata-conventions/tag-guide.md @@ -18,10 +18,10 @@ Tags help people find icons by concept, synonym, context, or common wording. Tags should always be lowercase. :::: example -::: do email +::: do email Lowercase tags **match the style** used across the icon library. ::: -::: dont Email +::: dont Email Capitalized tags create **inconsistent metadata** without improving search. ::: :::: @@ -31,10 +31,10 @@ Capitalized tags create **inconsistent metadata** without improving search. Use one clear word when it is enough. Use multi-word tags when the phrase is clearer. :::: example -::: do search +::: do search This is **short, common, and easy to find**. ::: -::: dont searching through files & folders +::: dont searching through files & folders This reads like a **use case**, not a tag. ::: :::: @@ -44,10 +44,10 @@ This reads like a **use case**, not a tag. Some ideas are only clear as a phrase. But keep those phrases short. :::: example -::: do blood type +::: do blood type The phrase is **clearer** than either word on its own. ::: -::: dont blood type medical label +::: dont blood type medical label This combines **several search concepts** into one long tag. ::: :::: @@ -57,10 +57,10 @@ This combines **several search concepts** into one long tag. Tags can include words people are likely to search for, even if they are not in the icon name. :::: example -::: do email +::: do email This helps users find `mail` icons using a **common synonym**. ::: -::: dont electronic postal message delivery +::: dont electronic postal message delivery This is unlikely search wording and **adds noise**. ::: :::: @@ -70,10 +70,10 @@ This is unlikely search wording and **adds noise**. The icon name is already searchable. Tags should add other ways to find it. :::: example -::: do message filter +::: do message filter This adds a **related concept** for `mail-search` without duplicating the name. ::: -::: dont mail search +::: dont mail search This **repeats the icon name** and does not improve discovery. ::: :::: @@ -83,10 +83,10 @@ This **repeats the icon name** and does not improve discovery. Tags should describe the icon, not say that it is an icon. :::: example -::: do event +::: do event This points to a **specific idea** users might search for. ::: -::: dont icon +::: dont icon **Every entry is an icon**, so this tag does not help anyone find the right one. ::: :::: @@ -96,10 +96,10 @@ This points to a **specific idea** users might search for. Do not add loose terms just to make an icon appear in more searches. :::: example -::: do emergency room +::: do emergency room This is **relevant** for an icon that marks emergency room locations. ::: -::: dont doctor nurse pharmacy +::: dont doctor nurse pharmacy These terms may be **nearby concepts**, but they do not all describe the same icon. ::: :::: @@ -109,10 +109,10 @@ These terms may be **nearby concepts**, but they do not all describe the same ic Related icons can share family terms, but variant tags should describe what is different. :::: example -::: do depleted +::: do depleted This distinguishes `battery-low` from **other battery icons**. ::: -::: dont charged +::: dont charged This describes `battery-full` better than `battery-low`. ::: :::: @@ -122,10 +122,10 @@ This describes `battery-full` better than `battery-low`. Check similar icons before adding new tags. Reusing existing terms keeps search predictable. :::: example -::: do typography +::: do typography This matches existing text-formatting icons and keeps **related icons** together in search. ::: -::: dont fontography +::: dont fontography Inventing a new term makes the icon harder to find and less consistent with related metadata. ::: :::: diff --git a/docs/contribute/icons/metadata-conventions/use-case-guide.md b/docs/contribute/icons/metadata-conventions/use-case-guide.md index 0f4780a81..c3c9d974c 100644 --- a/docs/contribute/icons/metadata-conventions/use-case-guide.md +++ b/docs/contribute/icons/metadata-conventions/use-case-guide.md @@ -16,10 +16,10 @@ This guide shows how to write clear use cases for Lucide icons. Describe what the interface tells the user. Do not write from the contributor's point of view. :::: example -::: do Indicating a device is offline or unreachable +::: do Indicating a device is offline or unreachable This describes the **role the icon plays in an interface**. ::: -::: dont I need an icon for my offline device screen +::: dont I need an icon for my offline device screen This explains the **contributor's situation**, not the icon's purpose. ::: :::: @@ -29,10 +29,10 @@ This explains the **contributor's situation**, not the icon's purpose. A use case should explain what the icon means in context. Do not repeat the icon name or only describe the drawing. :::: example -::: do Representing processors, chips, or embedded hardware +::: do Representing processors, chips, or embedded hardware This explains `microchip` **without repeating the name**. ::: -::: dont it's a microchip icon +::: dont it's a microchip icon This **duplicates the icon name** and does not explain where the icon would be used. ::: :::: @@ -42,10 +42,10 @@ This **duplicates the icon name** and does not explain where the icon would be u Some icons have broad meanings. Add context when it makes the use case clearer. :::: example -::: do Applying a level-2 heading in text editors +::: do Applying a level-2 heading in text editors The phrase explains both the **action and the product area**. ::: -::: dont Applying a heading +::: dont Applying a heading This is less useful because it **omits the level and context**. ::: :::: @@ -55,10 +55,10 @@ This is less useful because it **omits the level and context**. Each entry should cover one clear idea. Split different meanings into separate entries. :::: example -::: do Marking parking locations on maps +::: do Marking parking locations on maps This is **short, clear, and focused** on one interface function. ::: -::: dont Marking parking, transport, maps, cars, garages, and places +::: dont Marking parking, transport, maps, cars, garages, and places This reads like a **tag list** and **mixes several ideas**. ::: :::: @@ -68,10 +68,10 @@ This reads like a **tag list** and **mixes several ideas**. For related icons, describe what makes each variant different. :::: example -::: do Indicating a low battery charge level +::: do Indicating a low battery charge level This is specific to `battery-low` and **sets it apart** from other battery icons. ::: -::: dont Representing battery status +::: dont Representing battery status This is **too generic** and could apply to **every battery variant**. ::: :::: @@ -81,10 +81,10 @@ This is **too generic** and could apply to **every battery variant**. Use cases should make sense after the pull request is merged. :::: example -::: do Signifying a deal, agreement, or partnership +::: do Signifying a deal, agreement, or partnership This keeps the **useful meaning** without depending on **outside context**. ::: -::: dont Same as above in #1234 +::: dont Same as above in #1234 This **depends on a discussion** readers **may never see**. ::: :::: @@ -94,10 +94,10 @@ This **depends on a discussion** readers **may never see**. Use cases should usually be 4 to 12 words. Prefer a short phrase over a long explanation. :::: example -::: do Searching files by name or content +::: do Searching files by name or content This is **short enough** to scan and **specific enough** to understand. ::: -::: dont This icon can be used when users want to search through all of their files and folders to find something +::: dont This icon can be used when users want to search through all of their files and folders to find something This is **too long** and reads like **product copy instead of metadata**. ::: :::: @@ -107,10 +107,10 @@ This is **too long** and reads like **product copy instead of metadata**. Use cases are metadata phrases, not full sentences. :::: example -::: do Confirming a successful payment +::: do Confirming a successful payment This matches the **phrase style** used across icon metadata. ::: -::: dont Confirming a successful payment. +::: dont Confirming a successful payment. The period adds **unnecessary punctuation** and makes entries inconsistent. ::: :::: @@ -120,10 +120,10 @@ The period adds **unnecessary punctuation** and makes entries inconsistent. Use plain text only. Formatting belongs in documentation, not metadata values. :::: example -::: do Warning users about a destructive action +::: do Warning users about a destructive action This works in search, generated pages, and other places that use metadata. ::: -::: dont **Warning** users about a destructive action ⚠️ +::: dont **Warning** users about a destructive action ⚠️ Markdown and emoji can **show up in generated UI** and make metadata **harder to reuse**. ::: :::: @@ -133,10 +133,10 @@ Markdown and emoji can **show up in generated UI** and make metadata **harder to Use cases should describe meaning, not how the SVG was made. :::: example -::: do Representing cropped or trimmed content +::: do Representing cropped or trimmed content This explains the icon's **interface meaning**. ::: -::: dont Showing a rectangle with two path cuts and adjusted Bezier handles +::: dont Showing a rectangle with two path cuts and adjusted Bezier handles This describes **construction details** that do not help people find or understand the icon. ::: :::: diff --git a/docs/contribute/icons/naming-conventions.md b/docs/contribute/icons/naming-conventions.md index 49aac9983..a0b507195 100644 --- a/docs/contribute/icons/naming-conventions.md +++ b/docs/contribute/icons/naming-conventions.md @@ -82,19 +82,19 @@ Icon names **must** use American English, not local variants. Icon names **must** describe what the icon shows, not how someone might use it. :::: example -::: do `floppy-disk` +::: do `floppy-disk` The icon **shows** a floppy disk. ::: -::: dont `save` +::: dont `save` Save is a use case. ::: :::: :::: example -::: do `circle-slash` +::: do `circle-slash` The icon **shows** a circle with a slash across it. ::: -::: dont `ban` +::: dont `ban` Ban is an action. ::: :::: @@ -110,10 +110,10 @@ Icons that belong to the same group **must** use the `-` naming The group name comes first. The variant comes after it. :::: example -::: do + `badge-plus` & `badge-check` +::: do + `badge-plus` & `badge-check` `badge` is the group. ::: -::: dont + `plus-badge` & `check-badge` +::: dont + `plus-badge` & `check-badge` `plus` and `check` are not the group. ::: :::: @@ -123,10 +123,10 @@ The group name comes first. The variant comes after it. Alternate versions of an icon **must** be named for what makes them visually different. Do **not** use numbers just to separate one version from another. :::: example -::: do `send-horizontal` +::: do `send-horizontal` The icon depicts a horizontal "send" symbol. ::: -::: dont `send-2` or `send-alt` +::: dont `send-2` or `send-alt` "send number 2" and "alternative send" are not clear names. ::: :::: @@ -136,19 +136,19 @@ The icon depicts a horizontal "send" symbol. Icon names **must not** include numbers unless the icon shows the number. :::: example -::: do `arrow-down-0-1` +::: do `arrow-down-0-1` The arrow points from 0 to 1. ::: -::: dont `send-2` +::: dont `send-2` The icon does not show the number 2. ::: :::: :::: example -::: do `clock-3` +::: do `clock-3` The hands point to 3 o'clock. ::: -::: dont `user-3` +::: dont `user-3` The icon does not show the number 3. ::: :::: @@ -162,10 +162,10 @@ When an icon shows multiple elements of different sizes, order their names from For an icon containing a circle and a person: :::: example -::: do `moon-star` +::: do `moon-star` The `moon` is larger than the `star`. ::: -::: dont `person-circle` +::: dont `person-circle` The `person` is **not** larger than the `circle`. ::: :::: @@ -179,19 +179,19 @@ If elements overlap, name them from front to back. If they do not overlap, name them in English reading order: top to bottom, then left to right. :::: example -::: do `pencil-ruler` +::: do `pencil-ruler` The `pencil` is **in front** of the `ruler`, so it comes first. ::: -::: do `ruler-dimension-line` +::: do `ruler-dimension-line` The ruler is below the dimension line, but it is **larger**, so it comes first. ::: :::: :::: example -::: do `sun-snow` +::: do `sun-snow` The `sun` is **left of** the `snowflake`, so it comes first. ::: -::: dont `ruler-pencil` +::: dont `ruler-pencil` The `ruler` is **below** the `pencil`, so `pencil-ruler` is the correct name. ::: :::: @@ -201,10 +201,10 @@ The `ruler` is **below** the `pencil`, so `pencil-ruler` is the correct name. Modifiers **must** come after the element they describe: `-`. :::: example -::: do `heart-broken` +::: do `heart-broken` The icon shows a heart that is **cracked**. ::: -::: dont `broken-bone` +::: dont `broken-bone` The icon shows a bone that is **broken**, so name it `bone-broken`. ::: :::: @@ -212,12 +212,12 @@ The icon shows a bone that is **broken**, so name it `bone-broken`. When an icon has multiple modified elements, each modifier **must** follow the element it describes. :::: example -::: do `circle-fading-arrow-up` +::: do `circle-fading-arrow-up` The icon shows a **fading** circle with an arrow pointing **up** inside it. `circle` comes first because it is larger than `arrow`. `fading` follows `circle` because it modifies the circle. `up` follows `arrow` because it modifies the arrow. ::: -::: dont `notepad-text-dashed` +::: dont `notepad-text-dashed` This icon shows a dashed notepad with text inside, so name it `notepad-dashed-text`. `notepad` comes first because it is larger than `text`. `dashed` follows `notepad` because it modifies the notepad. `text` follows both because `dashed` does not modify `text`.