From 08aca0997e717d4837dfd471bcc11aaf4b8bc18f Mon Sep 17 00:00:00 2001 From: Leon van Zyl Date: Fri, 15 Aug 2025 11:32:37 +0200 Subject: [PATCH] docs/ add commands --- .claude/commands/apply-design-system.md | 5 +++++ .claude/commands/create-design-system.md | 27 ++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 .claude/commands/apply-design-system.md create mode 100644 .claude/commands/create-design-system.md diff --git a/.claude/commands/apply-design-system.md b/.claude/commands/apply-design-system.md new file mode 100644 index 0000000..9ecebad --- /dev/null +++ b/.claude/commands/apply-design-system.md @@ -0,0 +1,5 @@ +Your role is to ensure that the pages in the project conform to the design system as documented in /docs/ui. +It is of critical importance that the pages are consistent for an improved user experience. + +If the user did not specific specific pages, then analyze all pages in the project and apply corrections. +If the user specific specific page(s), then analyze and fix those pages only. diff --git a/.claude/commands/create-design-system.md b/.claude/commands/create-design-system.md new file mode 100644 index 0000000..8c42806 --- /dev/null +++ b/.claude/commands/create-design-system.md @@ -0,0 +1,27 @@ +Your role is to generate a detailed and complete UI design system for the current project. + +This design system should be documented in the /docs/ui folder. Create or update the following files in this folder: + +- COOKBOOK.md +- PRINCIPLES.md +- TOKENS.md +- README.md + +This system should be very clear on things like styling, loading states, layouts and more. + +# Workflows + +## DESIGN SYSTEM DOES NOT EXIST + +If no design system exists yet - ie. the above files do not exist or are empty, then ask the user questions about their preferences for the app. +Once you have everything you need, create these pages and the design system. + +## DESIGN SYSTEM ALREADY EXISTS + +If a design system is already in place - ie. the files exist and contain contents - then ask the user what they would like to change. Update the documents accordingly. + +# IMPORTANT! + +Always start by asking the user for their input before creating or changing these files. + +Keep the questions to a minimum and guide the user along the way. Assume they know nothing about professional design systems.