From 1b5a0e5b01bdc65b0346a4338d17981732e6ba3a Mon Sep 17 00:00:00 2001 From: Philip Allgaier Date: Sun, 23 Jul 2023 21:56:11 +0200 Subject: [PATCH] Add info about design portal to frontend dev docs (#1796) Co-authored-by: Franck Nijhof --- docs/frontend/design.md | 17 +++++++++++++++++ sidebars.js | 1 + 2 files changed, 18 insertions(+) create mode 100644 docs/frontend/design.md diff --git a/docs/frontend/design.md b/docs/frontend/design.md new file mode 100644 index 00000000..dbc8f49e --- /dev/null +++ b/docs/frontend/design.md @@ -0,0 +1,17 @@ +--- +title: "Frontend design" +sidebar_label: "Design" +--- + +We maintain a design portal at that provides information about various frontend aspects such as: + +* UI components that can be reused. +* Dashboard cards in various configurations and states. +* Easy way to compare components and cards between light and dark themes. +* Notes about specific wording in Home Assistant. + +When new components or features are added to the frontend, those need to be added to the design portal. This portal page explains the details on how to do so: + +:::note +While the portal is publically named "design", it is referred to as "gallery" in the frontend repository. That is why the script to run the gallery locally in your development environment can be found at `gallery/script/develop_gallery` and the source code in `gallery/src`. +:: diff --git a/sidebars.js b/sidebars.js index 3223a49f..aaf36a54 100644 --- a/sidebars.js +++ b/sidebars.js @@ -21,6 +21,7 @@ module.exports = { Frontend: [ "frontend", "frontend/architecture", + "frontend/design", "frontend/development", "frontend/data", "frontend/external-authentication",