fix(docs): use kebab-case filename rule and acknowledge views/ subfolder

- Change golden rule #8 from camelCase to kebab-case to match the
  actual convention used by all 47+ icons in the plugin
- Acknowledge the icons/views/ subfolder in the roles intro and
  placement section
This commit is contained in:
kiloconnect[bot]
2026-07-30 19:51:51 +00:00
parent ffce3e4d42
commit aa79e0f43f
+3 -3
View File
@@ -19,11 +19,11 @@ Background: the IDE maintains Classic UI and New UI in parallel. Code branches w
5. **Use `fill="none"` on the root `<svg>`** and set `fill` / `stroke` explicitly per shape — never rely on CSS or `currentColor`.
6. **Strokes use `stroke-width="1"`, `stroke-linecap="round"`, `stroke-linejoin="round"`** (or `stroke-miterlimit="10"` for hard joins). Heavier strokes are reserved for hero glyphs inside a circle badge (e.g. status checkmarks) and use `stroke-width="1.5"` or `"2"`.
7. **Pixel-grid align**: keep stroke axes on half-pixel centers (`x.5`) and fills on whole pixels so the icon stays crisp at 1× rendering.
8. **File names use camelCase** matching the action/node ID and stay ASCII-only.
8. **File names use kebab-case** (e.g. `arrow-down-to-line.svg`, `book-open-check.svg`) and stay ASCII-only. This matches the naming convention used by all icons in `packages/kilo-jetbrains/frontend/src/main/resources/icons/`.
## Icon roles
All roles land flat in this repo's `packages/kilo-jetbrains/frontend/src/main/resources/icons/` (no subfolders — see [Where the SVGs live](#where-the-svgs-live)). The "Upstream reference dir" column below is where the same role lives in the IntelliJ Community sources (`$INTELLIJ_REPO`), useful when you need to look up an existing icon's conventions or geometry — it is not a path in this repo.
All roles land in this repo's `packages/kilo-jetbrains/frontend/src/main/resources/icons/` (with a `views/` subfolder for in-view icons — see [Where the SVGs live](#where-the-svgs-live)). The "Upstream reference dir" column below is where the same role lives in the IntelliJ Community sources (`$INTELLIJ_REPO`), useful when you need to look up an existing icon's conventions or geometry — it is not a path in this repo.
| Role | Canvas | Filename pattern | Upstream reference dir (`$INTELLIJ_REPO`) |
|---|---|---|---|
@@ -42,7 +42,7 @@ When in doubt, find a sibling icon of the same role in this repo's flat icons fo
## Where the SVGs live
**In this repo**, all plugin icons — regardless of role — go flat into `packages/kilo-jetbrains/frontend/src/main/resources/icons/`. There is no `expui/` subfolder structure and no `*IconMappings.json` file here; the plugin loads icons directly from that flat folder via `IconLoader`. Place both the light SVG and its `_dark` sibling there and reference them from the plugin's icon-holder class.
**In this repo**, plugin icons go into `packages/kilo-jetbrains/frontend/src/main/resources/icons/` (action icons, tool-window icons) or the `icons/views/` subfolder (in-view icons used by the chat/session UI). There is no `expui/` subfolder structure and no `*IconMappings.json` file here; the plugin loads icons directly via `IconLoader`. Place both the light SVG and its `_dark` sibling there and reference them from the plugin's icon-holder class.
The rest of this section describes how the **upstream IntelliJ Community** sources (reachable via `$INTELLIJ_REPO` — see `packages/kilo-jetbrains/AGENTS.md`) organize the same icons. That structure is useful when consulting or copying conventions from an existing platform icon, but it is not a path that exists in this repo.