From f61cce961aa81af8d22d77f1c7fb929991fe6960 Mon Sep 17 00:00:00 2001 From: Aishat Muibudeen <105395613+Mayaleeeee@users.noreply.github.com> Date: Thu, 25 Jun 2026 09:30:14 +0100 Subject: [PATCH] Add icons usage guidelines to README Added guidelines for using icons from the AsyncAPI Design system, including steps for adding or replacing icons. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 09ef0b826..6b50cdfad 100644 --- a/README.md +++ b/README.md @@ -121,3 +121,16 @@ Studio can resolve local file references (e.g., `$ref: './schema.avsc'`) by requ ### List existing architecture decision records See [doc/adr](doc/adr) + +### Icons Usage +Studio uses icons from the [AsyncAPI Design system](https://www.figma.com/design/cFsY4LCfKmDqdlaTIJPpA1/AsyncAPI-Design-System?node-id=354-2046&p=f&t=CINUpbY33cZmalFG-0). All icons should follow the AsyncAPI design system — 24px grid, 1.5px stroke, outline style only. +If you need to add or replace an icon in Studio, follow these steps: + +- Open the [AsyncAPI Design system](https://www.figma.com/design/cFsY4LCfKmDqdlaTIJPpA1/AsyncAPI-Design-System?node-id=354-2046&p=f&t=CINUpbY33cZmalFG-0) Figma file +- Find the correct icon +Screenshot 2026-06-25 at 09 27 54 + +- Right-click → Copy as → SVG +hacopy + +Do not import icons from react-icons, Font Awesome, Heroicons, or any other external library. See the [Icon System documentation](https://www.figma.com/design/kXSY2ELWaViixVT5gHZUGK/AsyncAPI-Icon-System?node-id=45-462&t=aE3kEtdRSApYj7XK-0) for the full usage and contribution guidelines.