@equal-experts/kuat-react 0.13.1 → 0.14.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -49
- package/agent-docs/AGENTS.md +2 -2
- package/agent-docs/README.md +1 -1
- package/agent-docs/bundle-manifest.json +12 -20
- package/agent-docs/components/components.manifest.json +3 -0
- package/agent-docs/external/kuat-agent-rules/reference/accessibility/README.md +7 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/accessibility}/accessibility.md +12 -10
- package/agent-docs/external/kuat-agent-rules/reference/brand/README.md +9 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/brand.md +21 -11
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/logo.md +5 -4
- package/agent-docs/external/kuat-agent-rules/reference/brand/voice-and-tone.md +166 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/README.md +12 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/formatting.md +120 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/numbers.md +87 -0
- package/agent-docs/external/kuat-agent-rules/reference/content/punctuation.md +94 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference}/content/writing-style.md +7 -2
- package/agent-docs/external/kuat-agent-rules/reference/design-language/README.md +11 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/borders.md +3 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/colours.md +38 -10
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/design-language.md +11 -10
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/spacing.md +4 -3
- package/agent-docs/external/kuat-agent-rules/reference/design-language/tokens/README.md +29 -0
- package/agent-docs/external/kuat-agent-rules/reference/design-language/tokens/colors.tokens.json +84 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/typography.md +5 -4
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/README.md +10 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/README.md +2 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/blog-posts.md +1 -5
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/marketing-content.md +2 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/seo.md +2 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/emails.md +3 -9
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/patterns/README.md +7 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing/scenarios → reference/media-types/web-marketing/patterns}/marketing-pages.md +3 -3
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/website.md +7 -22
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/README.md +16 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/accessibility.md +2 -12
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/component-decision-tree.md +3 -18
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/component-registry.md +3 -22
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/README.md +2 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/actions.md +1 -7
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/confirmations.md +0 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/empty-states.md +0 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/errors.md +0 -6
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/forms.md +1 -7
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/product-content.md +1 -11
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/design.md +6 -36
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/emails.md +3 -9
- package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/patterns/README.md +10 -0
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/authentication.md +3 -3
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/dashboards.md +2 -2
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/documentation.md +3 -3
- package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/forms.md +3 -3
- package/agent-docs/kuat-docs/rules/README.md +37 -30
- package/agent-docs/kuat-docs/rules/design/layouts.md +1 -1
- package/agent-docs/kuat-docs/rules/scenarios/README.md +1 -1
- package/agent-docs/manifest.json +3 -3
- package/agent-docs/rules/LOADING-consumer.md +5 -5
- package/dist/components/ui/carousel/carousel.d.ts +1 -1
- package/dist/style.css +1 -1
- package/package.json +2 -2
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/LOADING.md +0 -166
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/README.md +0 -28
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/formatting.md +0 -93
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/numbers.md +0 -69
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/punctuation.md +0 -75
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/voice-and-tone.md +0 -263
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/design/README.md +0 -28
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/marketing/scenarios/README.md +0 -18
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/DEPRECATIONS.md +0 -28
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/README.md +0 -65
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/review-checklist.md +0 -57
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/review-context.md +0 -44
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/scenarios/README.md +0 -82
- package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/technical.md +0 -488
|
@@ -142,14 +142,15 @@ Establish clear visual hierarchy:
|
|
|
142
142
|
|
|
143
143
|
For platform-specific typography guidance:
|
|
144
144
|
|
|
145
|
-
- **Web** - See [types/web/](../types/web/)
|
|
146
|
-
- **
|
|
147
|
-
- **
|
|
145
|
+
- **Web product** - See [media-types/web-product/](../media-types/web-product/)
|
|
146
|
+
- **Web marketing** - See [media-types/web-marketing/](../media-types/web-marketing/)
|
|
147
|
+
- **Slides** - See [media-types/slides/](../media-types/slides/)
|
|
148
|
+
- **Graphics** - See [media-types/imagery/patterns/graphics/](../media-types/imagery/patterns/graphics/)
|
|
148
149
|
|
|
149
150
|
---
|
|
150
151
|
|
|
151
152
|
## Related Documentation
|
|
152
153
|
|
|
153
|
-
- [Brand Guidelines](
|
|
154
|
+
- [Brand Guidelines](../brand/brand.md) - Brand principles
|
|
154
155
|
- [Colours](./colours.md) - Text colors
|
|
155
156
|
- [Spacing](./spacing.md) - Text spacing patterns
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Web Marketing
|
|
2
|
+
|
|
3
|
+
Reference for Equal Experts public-facing marketing websites, landing pages, and marketing emails.
|
|
4
|
+
|
|
5
|
+
| File | Scope |
|
|
6
|
+
|------|-------|
|
|
7
|
+
| [website.md](./website.md) | Marketing website layout and visual patterns |
|
|
8
|
+
| [emails.md](./emails.md) | Marketing email patterns |
|
|
9
|
+
| [content/](./content/) | Marketing copy, blog posts, SEO |
|
|
10
|
+
| [patterns/](./patterns/) | Marketing page-type patterns |
|
|
@@ -6,7 +6,7 @@ Content guidance for Equal Experts marketing websites, landing pages, and blog p
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
Marketing content informs, engages, and supports conversion.
|
|
9
|
+
Marketing content informs, engages, and supports conversion. See [voice and tone](../../../brand/voice-and-tone.md) and [marketing-content.md](./marketing-content.md) for principles and content types.
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
@@ -22,5 +22,5 @@ Marketing content informs, engages, and supports conversion. Load [foundations c
|
|
|
22
22
|
|
|
23
23
|
## Related
|
|
24
24
|
|
|
25
|
-
- [
|
|
25
|
+
- [Content](../../../content/)
|
|
26
26
|
- [Marketing website](../website.md)
|
|
@@ -4,10 +4,6 @@ Structure and style for Equal Experts blog content.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
**Prerequisites:** [Foundations voice and tone](../../../../foundations/content/voice-and-tone.md), [marketing content](./marketing-content.md).
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
## Structure
|
|
12
8
|
|
|
13
9
|
1. **Introduction** – Hook the reader: story, question, or clear insight. Get to the point quickly.
|
|
@@ -20,7 +16,7 @@ Structure and style for Equal Experts blog content.
|
|
|
20
16
|
|
|
21
17
|
## Voice and Format
|
|
22
18
|
|
|
23
|
-
- Use [
|
|
19
|
+
- Use [writing style](../../../content/writing-style.md): active voice, plain language, "you" and "we".
|
|
24
20
|
- Keep paragraphs short (3–4 sentences). Use lists and headings so content is scannable.
|
|
25
21
|
- Support claims with evidence and examples. Avoid generic or unsupported statements.
|
|
26
22
|
- Typical length: enough to cover the topic clearly; avoid padding. For many posts, a few hundred to ~1,500 words works well.
|
|
@@ -4,10 +4,6 @@ Writing principles and content types for Equal Experts marketing websites and la
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
**Prerequisites:** Load [foundations](../../../../foundations/) first, especially [voice and tone](../../../../foundations/content/voice-and-tone.md).
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
## Overview
|
|
12
8
|
|
|
13
9
|
Marketing content is written to build awareness, demonstrate expertise, and support leads and opportunities. It can be more expansive than product UI copy but should still be clear and evidence-based.
|
|
@@ -28,7 +24,7 @@ Marketing content is written to build awareness, demonstrate expertise, and supp
|
|
|
28
24
|
**Tone range:** Confident to conversational (depends on content type)
|
|
29
25
|
**Key balance:** Expertise + Clarity = Credibility
|
|
30
26
|
|
|
31
|
-
Stay true to [
|
|
27
|
+
Stay true to [voice and tone](../../../brand/voice-and-tone.md): clear, direct, helpful. Avoid hype or vague claims.
|
|
32
28
|
|
|
33
29
|
---
|
|
34
30
|
|
|
@@ -59,7 +55,7 @@ Stay true to [foundations voice and tone](../../../../foundations/content/voice-
|
|
|
59
55
|
|
|
60
56
|
## Related
|
|
61
57
|
|
|
62
|
-
- [
|
|
58
|
+
- [Content](../../../content/)
|
|
63
59
|
- [Blog posts](./blog-posts.md)
|
|
64
60
|
- [SEO](./seo.md)
|
|
65
61
|
- [Marketing website](../website.md)
|
|
@@ -4,14 +4,10 @@ Guidance for findable, readable, and helpful marketing content.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
**Prerequisites:** [Foundations content](../../../../foundations/content/README.md), [marketing content](./marketing-content.md).
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
## Principles
|
|
12
8
|
|
|
13
9
|
- **Findable** – Use language people search for; structure and meta data support discovery.
|
|
14
|
-
- **Readable** – Clear headings, short paragraphs, plain language (see [writing style](
|
|
10
|
+
- **Readable** – Clear headings, short paragraphs, plain language (see [writing style](../../../content/writing-style.md)).
|
|
15
11
|
- **Helpful** – Content should answer a real question or need. Don't optimise for search at the expense of the reader.
|
|
16
12
|
|
|
17
13
|
---
|
|
@@ -39,6 +35,6 @@ Guidance for findable, readable, and helpful marketing content.
|
|
|
39
35
|
|
|
40
36
|
## Related
|
|
41
37
|
|
|
42
|
-
- [Formatting](
|
|
38
|
+
- [Formatting](../../../content/formatting.md) – Headings, links
|
|
43
39
|
- [Marketing content](./marketing-content.md)
|
|
44
40
|
- [Blog posts](./blog-posts.md)
|
|
@@ -4,12 +4,6 @@ Guidelines for Equal Experts marketing emails and campaigns.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
**Status:** Placeholder - details to be defined
|
|
8
|
-
|
|
9
|
-
**Prerequisites:** Load [foundations](../../../foundations/) first
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
7
|
## Overview
|
|
14
8
|
|
|
15
9
|
Marketing emails are external communications designed to engage, inform, and convert prospects and customers.
|
|
@@ -52,7 +46,7 @@ Marketing emails are external communications designed to engage, inform, and con
|
|
|
52
46
|
|
|
53
47
|
## Content Guidelines
|
|
54
48
|
|
|
55
|
-
Follow [
|
|
49
|
+
Follow [content](../../content/) for writing style.
|
|
56
50
|
|
|
57
51
|
### Subject Lines
|
|
58
52
|
- Keep under 50 characters for mobile
|
|
@@ -69,6 +63,6 @@ Follow [foundations/content/](../../../foundations/content/) for writing style.
|
|
|
69
63
|
|
|
70
64
|
## Related Documentation
|
|
71
65
|
|
|
72
|
-
- [
|
|
66
|
+
- [Reference home](../../README.md) - Brand and design language
|
|
73
67
|
- [Marketing Website](./website.md) - Website guidelines
|
|
74
|
-
- [Content](
|
|
68
|
+
- [Content](../../content/) - Writing style
|
package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/patterns/README.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Web Marketing Patterns
|
|
2
|
+
|
|
3
|
+
Applied layout and design patterns for marketing website page types.
|
|
4
|
+
|
|
5
|
+
| Pattern | For | Base layout |
|
|
6
|
+
|---------|-----|-------------|
|
|
7
|
+
| [marketing-pages.md](./marketing-pages.md) | Landing pages, pricing, features, case studies | Horizontal navigation |
|
|
@@ -243,7 +243,7 @@ Marketing pages use full-width sections with contained content.
|
|
|
243
243
|
|
|
244
244
|
## Accessibility
|
|
245
245
|
|
|
246
|
-
**Base requirements:** See [
|
|
246
|
+
**Base requirements:** See [accessibility](../../../accessibility/accessibility.md)
|
|
247
247
|
|
|
248
248
|
**Scenario-specific:**
|
|
249
249
|
|
|
@@ -364,5 +364,5 @@ Marketing pages use full-width sections with contained content.
|
|
|
364
364
|
## Related Documentation
|
|
365
365
|
|
|
366
366
|
- [Marketing Website](../website.md) - Marketing website guidelines
|
|
367
|
-
- [
|
|
368
|
-
- [Logo Usage](
|
|
367
|
+
- [Accessibility](../../../accessibility/accessibility.md) - Accessibility principles
|
|
368
|
+
- [Logo Usage](../../../brand/logo.md) - Logo placement and variants
|
|
@@ -4,24 +4,9 @@ Guidelines for Equal Experts marketing websites and landing pages.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
**Prerequisites:** Load [foundations](../../../foundations/) first
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
## Overview
|
|
12
8
|
|
|
13
|
-
Marketing websites are public-facing pages designed to inform, engage, and convert visitors. They use light backgrounds with full-color branding.
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## When to Use Marketing Layout
|
|
18
|
-
|
|
19
|
-
Use marketing layout when:
|
|
20
|
-
- Creating public-facing website content
|
|
21
|
-
- Building landing pages
|
|
22
|
-
- External audience (customers, prospects, public)
|
|
23
|
-
- Content-focused pages (blog, documentation)
|
|
24
|
-
- No complex navigation or application features
|
|
9
|
+
Marketing websites are public-facing pages designed to inform, engage, and convert visitors. They use light backgrounds with full-color branding. They are public-facing, target external audiences (customers, prospects, public), and are content-focused without complex navigation or application features.
|
|
25
10
|
|
|
26
11
|
---
|
|
27
12
|
|
|
@@ -74,7 +59,7 @@ Use marketing layout when:
|
|
|
74
59
|
| Header | Full-color | 120-150px |
|
|
75
60
|
| Footer | Full-color | 100-120px |
|
|
76
61
|
|
|
77
|
-
See [
|
|
62
|
+
See [logo](../../brand/logo.md) for logo guidelines.
|
|
78
63
|
|
|
79
64
|
---
|
|
80
65
|
|
|
@@ -90,7 +75,7 @@ See [foundations/logo.md](../../../foundations/logo.md) for logo guidelines.
|
|
|
90
75
|
|
|
91
76
|
## Content Guidelines
|
|
92
77
|
|
|
93
|
-
Follow [
|
|
78
|
+
Follow [content](../../content/) for writing style.
|
|
94
79
|
|
|
95
80
|
### Marketing Content Should:
|
|
96
81
|
|
|
@@ -162,8 +147,8 @@ Follow [foundations/content/](../../../foundations/content/) for writing style.
|
|
|
162
147
|
|
|
163
148
|
## Related Documentation
|
|
164
149
|
|
|
165
|
-
- [
|
|
166
|
-
- [
|
|
167
|
-
- [Web
|
|
150
|
+
- [Reference home](../../README.md) - Brand and design language
|
|
151
|
+
- [Accessibility](../../accessibility/accessibility.md) - Accessibility principles
|
|
152
|
+
- [Web marketing overview](./README.md) - Common web principles
|
|
168
153
|
- [Marketing Emails](./emails.md) - Email guidelines
|
|
169
|
-
- [Marketing
|
|
154
|
+
- [Marketing Patterns](./patterns/) - Patterns for marketing pages
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Web Product
|
|
2
|
+
|
|
3
|
+
Reference for Equal Experts web applications, dashboards, internal tools, and product emails.
|
|
4
|
+
|
|
5
|
+
| File | Scope |
|
|
6
|
+
|------|-------|
|
|
7
|
+
| [design.md](./design.md) | Layout, navigation, product visual patterns |
|
|
8
|
+
| [accessibility.md](./accessibility.md) | Product accessibility requirements |
|
|
9
|
+
| [emails.md](./emails.md) | Transactional / product email patterns |
|
|
10
|
+
| [component-decision-tree.md](./component-decision-tree.md) | Which component source to use (Blocks → Kuat → shadcn → custom) |
|
|
11
|
+
| [component-registry.md](./component-registry.md) | Stable component IDs → overlay/package guides |
|
|
12
|
+
| [content/](./content/) | UX copy (actions, errors, forms, confirmations, empty states) |
|
|
13
|
+
| [patterns/](./patterns/) | Page-type patterns (auth, dashboards, documentation, forms) |
|
|
14
|
+
| [examples/](./examples/) | Framework code samples (React, Vue, CSS) |
|
|
15
|
+
|
|
16
|
+
Per-component usage, variants, and API live in the implementation overlay or npm package `agent-docs/components/`, resolved via the IDs in [component-registry.md](./component-registry.md) — not in this upstream tree.
|
|
@@ -1,19 +1,9 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: foundations/accessibility.md
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Technical Accessibility
|
|
8
2
|
|
|
9
3
|
Implementation rules for WCAG 2.2 AA compliance in web applications.
|
|
10
4
|
|
|
11
5
|
---
|
|
12
6
|
|
|
13
|
-
**Prerequisites:** Load [foundations accessibility](../../../foundations/accessibility.md) first.
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
7
|
## Quick reference
|
|
18
8
|
|
|
19
9
|
- **Semantic HTML:** Use `<button>`, `<a href>`, `<input>`, headings, lists, tables; avoid div/span for interactive or structural meaning.
|
|
@@ -396,7 +386,7 @@ Kuat components automatically respect `prefers-reduced-motion`. When building cu
|
|
|
396
386
|
|
|
397
387
|
## Related Documentation
|
|
398
388
|
|
|
399
|
-
- [
|
|
389
|
+
- [Accessibility foundations](../../accessibility/accessibility.md) - Principles and guidelines
|
|
400
390
|
- [Component Decision Tree](./component-decision-tree.md) - Component selection and patterns
|
|
401
391
|
- [Product Design](./design.md) - Layout patterns
|
|
402
|
-
- [Product
|
|
392
|
+
- [Product Patterns](./patterns/) - Applied patterns for specific page types
|
|
@@ -1,19 +1,9 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: foundations
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Component Decision Tree
|
|
8
2
|
|
|
9
3
|
Component selection and development patterns for Equal Experts web applications.
|
|
10
4
|
|
|
11
5
|
---
|
|
12
6
|
|
|
13
|
-
**Prerequisites:** Load [foundations](../../../foundations/) first.
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
7
|
## Overview
|
|
18
8
|
|
|
19
9
|
When building UI for web applications, follow this priority order to ensure consistency and reduce maintenance burden.
|
|
@@ -72,7 +62,7 @@ Build from scratch only when:
|
|
|
72
62
|
|
|
73
63
|
## Per-component guides
|
|
74
64
|
|
|
75
|
-
Usage, variants, API, and accessibility for each primitive are **not** duplicated in this upstream file.
|
|
65
|
+
Usage, variants, API, and accessibility for each primitive are **not** duplicated in this upstream file. They live as `components/{slug}.md` in the consumer package `agent-docs/` or overlay, resolved by stable ID via [component-registry.md](./component-registry.md):
|
|
76
66
|
|
|
77
67
|
| ID | Guide location |
|
|
78
68
|
|----|----------------|
|
|
@@ -80,11 +70,7 @@ Usage, variants, API, and accessibility for each primitive are **not** duplicate
|
|
|
80
70
|
| `kuat:button-group` | `components/button-group.md` |
|
|
81
71
|
| `kuat:kuat-header` | `components/kuat-header.md` |
|
|
82
72
|
|
|
83
|
-
|
|
84
|
-
2. Resolve path via `COMPONENT_MANIFEST` (`ensure-rules.sh` output) or `{RULES_ROOT}/agent-docs/components.manifest.json`.
|
|
85
|
-
3. Load only the component docs referenced by the current task or artifact.
|
|
86
|
-
|
|
87
|
-
Architecture: [consumption-architecture.md](../../../../setup/consumption-architecture.md).
|
|
73
|
+
See [consumption-architecture.md](../../../kuat-docs/setup/consumption-architecture.md) for the resolution architecture.
|
|
88
74
|
|
|
89
75
|
---
|
|
90
76
|
|
|
@@ -191,7 +177,7 @@ Always specify `defaultVariants`:
|
|
|
191
177
|
|
|
192
178
|
### Design Tokens
|
|
193
179
|
|
|
194
|
-
- Use semantic color tokens (`bg-primary`, not
|
|
180
|
+
- Use semantic color tokens (`bg-primary`, not a raw hex)
|
|
195
181
|
- Use spacing scale (`p-4`, not `padding: 17px`)
|
|
196
182
|
- Use border radius rules (0px/4px/6px)
|
|
197
183
|
|
|
@@ -258,6 +244,5 @@ Before shipping a component, verify:
|
|
|
258
244
|
## Related Documentation
|
|
259
245
|
|
|
260
246
|
- [Accessibility](./accessibility.md) - Technical accessibility implementation
|
|
261
|
-
- [Technical Guidelines](./technical.md) - Setup and integration
|
|
262
247
|
- [Design Rules](./design.md) - Layout and visual design
|
|
263
248
|
- [Examples](./examples/) - Framework-specific code examples
|
|
@@ -1,24 +1,6 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: foundations, component-decision-tree.md
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Component registry
|
|
8
2
|
|
|
9
|
-
Stable IDs link
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## How to use
|
|
14
|
-
|
|
15
|
-
1. Scenario or checklist cites an ID (e.g. `shadcn:button`).
|
|
16
|
-
2. Resolve via `components.manifest.json`:
|
|
17
|
-
- Package: `node_modules/@equal-experts/kuat-react/agent-docs/components.manifest.json`
|
|
18
|
-
- Overlay: `{KUAT_RULES_OVERLAY_PATH}/components.manifest.json`
|
|
19
|
-
3. Load `components/{slug}.md` from the manifest `path` field.
|
|
20
|
-
|
|
21
|
-
**Slug:** ID without namespace prefix (`shadcn:button` → `button`).
|
|
3
|
+
Stable IDs link patterns and checklists to per-component guides in the implementation overlay or npm `agent-docs/`. Component docs live as `components/{slug}.md` in the consumer package `agent-docs/` or overlay, resolved via `components.manifest.json`. The slug is the ID without its namespace prefix (`shadcn:button` → `button`).
|
|
22
4
|
|
|
23
5
|
---
|
|
24
6
|
|
|
@@ -26,7 +8,7 @@ Stable IDs link upstream scenarios and checklists to per-component guides in the
|
|
|
26
8
|
|
|
27
9
|
| ID | Display name | Source | Overlay / package doc | Upstream refs |
|
|
28
10
|
|----|--------------|--------|----------------------|---------------|
|
|
29
|
-
| `shadcn:button` | Button | shadcn CLI + `kuat-core` theme | `components/button.md` | [forms](./
|
|
11
|
+
| `shadcn:button` | Button | shadcn CLI + `kuat-core` theme | `components/button.md` | [forms](./patterns/forms.md), [authentication](./patterns/authentication.md), [content/actions](./content/actions.md) |
|
|
30
12
|
| `kuat:button-group` | ButtonGroup | `@equal-experts/kuat-react` / `kuat-vue` | `components/button-group.md` | [component-decision-tree](./component-decision-tree.md) |
|
|
31
13
|
| `kuat:kuat-header` | KuatHeader | `@equal-experts/kuat-react` / `kuat-vue` block | `components/kuat-header.md` | [component-decision-tree](./component-decision-tree.md), [design](./design.md) |
|
|
32
14
|
|
|
@@ -64,5 +46,4 @@ Authoritative manifest lives in `kuat-mono` and is published inside each package
|
|
|
64
46
|
## Related
|
|
65
47
|
|
|
66
48
|
- [component-decision-tree.md](./component-decision-tree.md)
|
|
67
|
-
- [consumption-architecture.md](
|
|
68
|
-
- [DEPRECATIONS.md](./DEPRECATIONS.md)
|
|
49
|
+
- [consumption-architecture.md](../../../kuat-docs/setup/consumption-architecture.md)
|
|
@@ -6,7 +6,7 @@ UX writing and content patterns for Equal Experts web applications.
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
Product content is the text inside product interfaces: buttons, errors, forms, confirmations, empty states.
|
|
9
|
+
Product content is the text inside product interfaces: buttons, errors, forms, confirmations, empty states. The [voice and tone](../../../brand/voice-and-tone.md) foundation and [product-content.md](./product-content.md) cover the core principles.
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
@@ -25,5 +25,5 @@ Product content is the text inside product interfaces: buttons, errors, forms, c
|
|
|
25
25
|
|
|
26
26
|
## Related
|
|
27
27
|
|
|
28
|
-
- [
|
|
28
|
+
- [Writing style](../../../content/writing-style.md)
|
|
29
29
|
- [Product design](../design.md)
|
|
@@ -1,9 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: foundations, foundations/content/voice-and-tone.md, product/content/product-content.md
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Actions (Buttons and Links)
|
|
8
2
|
|
|
9
3
|
Guidance for button labels and link text in product interfaces.
|
|
@@ -41,7 +35,7 @@ Guidance for button labels and link text in product interfaces.
|
|
|
41
35
|
|
|
42
36
|
- Use descriptive link text that states the destination or action
|
|
43
37
|
- Avoid "click here", "read more", or "learn more" without context
|
|
44
|
-
- See [
|
|
38
|
+
- See [content formatting](../../../content/formatting.md) for link guidelines
|
|
45
39
|
|
|
46
40
|
---
|
|
47
41
|
|
|
@@ -1,9 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: foundations, product/content/product-content.md
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Forms
|
|
8
2
|
|
|
9
3
|
Content guidance for forms: labels, placeholders, helper text, validation, and structure.
|
|
@@ -71,4 +65,4 @@ Content guidance for forms: labels, placeholders, helper text, validation, and s
|
|
|
71
65
|
|
|
72
66
|
- [Product content](./product-content.md)
|
|
73
67
|
- [Errors](./errors.md)
|
|
74
|
-
- [
|
|
68
|
+
- [Accessibility foundations](../../../accessibility/accessibility.md)
|
|
@@ -1,19 +1,9 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: foundations, foundations/content/voice-and-tone.md
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Product Content Guidelines
|
|
8
2
|
|
|
9
3
|
UX writing and content guidelines for Equal Experts web applications.
|
|
10
4
|
|
|
11
5
|
---
|
|
12
6
|
|
|
13
|
-
**Prerequisites:** Load [foundations](../../../../foundations/) first, especially [voice and tone](../../../../foundations/content/voice-and-tone.md).
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
7
|
## Overview
|
|
18
8
|
|
|
19
9
|
Product content is the text inside product interfaces, designed to help users complete tasks. It's more concise than marketing content and action-oriented.
|
|
@@ -128,7 +118,7 @@ Before writing, know:
|
|
|
128
118
|
|
|
129
119
|
## Related Documentation
|
|
130
120
|
|
|
131
|
-
- [
|
|
121
|
+
- [Voice and tone](../../../brand/voice-and-tone.md) - Voice, tone, style
|
|
132
122
|
- [Actions](./actions.md) - Buttons and links
|
|
133
123
|
- [Confirmations](./confirmations.md) - Confirmation dialogs
|
|
134
124
|
- [Empty states](./empty-states.md) - Empty state copy
|
|
@@ -1,38 +1,9 @@
|
|
|
1
|
-
---
|
|
2
|
-
scope: type
|
|
3
|
-
platform: web_product
|
|
4
|
-
prerequisites: general
|
|
5
|
-
---
|
|
6
|
-
|
|
7
1
|
# Product Design Rules
|
|
8
2
|
|
|
9
3
|
Design guidelines for Equal Experts web applications and product interfaces.
|
|
10
4
|
|
|
11
5
|
---
|
|
12
6
|
|
|
13
|
-
**Prerequisites:** Load [foundations](../../../foundations/) first.
|
|
14
|
-
|
|
15
|
-
**Intent:** Use skill [kuat-review](../../../../skills/kuat-review/SKILL.md) or [kuat-create](../../../../skills/kuat-create/SKILL.md) first.
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## Before you review
|
|
20
|
-
|
|
21
|
-
1. Run [kuat-review](../../../../skills/kuat-review/SKILL.md) intake (depth, artifacts, output format).
|
|
22
|
-
2. Gather product context per [review-context.md](./review-context.md) when depth is `product_ux` or `full`.
|
|
23
|
-
3. Apply [review-checklist.md](./review-checklist.md).
|
|
24
|
-
4. **Do not load** [examples/](./examples/) for review-only tasks.
|
|
25
|
-
|
|
26
|
-
---
|
|
27
|
-
|
|
28
|
-
## Before you create
|
|
29
|
-
|
|
30
|
-
1. Run [kuat-create](../../../../skills/kuat-create/SKILL.md).
|
|
31
|
-
2. Load this file, relevant [scenarios/](./scenarios/), and [content/](./content/) as needed.
|
|
32
|
-
3. Load [examples/](./examples/) when implementing UI in React, Vue, or CSS.
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
7
|
## Overview
|
|
37
8
|
|
|
38
9
|
Product layouts are for web applications, dashboards, and internal tools. They use **dark navigation** for clear visual hierarchy, distinguishing them from marketing layouts.
|
|
@@ -137,7 +108,7 @@ For dark navigation (horizontal or sidebar):
|
|
|
137
108
|
|
|
138
109
|
**Never use full-color logo on dark backgrounds.**
|
|
139
110
|
|
|
140
|
-
See [
|
|
111
|
+
See [logo guidelines](../../brand/logo.md).
|
|
141
112
|
|
|
142
113
|
---
|
|
143
114
|
|
|
@@ -172,8 +143,8 @@ See [foundations/logo.md](../../../foundations/logo.md) for logo guidelines.
|
|
|
172
143
|
### Cards and Panels
|
|
173
144
|
|
|
174
145
|
- Use `bg-card` token for card backgrounds
|
|
175
|
-
- Follow [
|
|
176
|
-
- Follow [
|
|
146
|
+
- Follow [borders](../../design-language/borders.md) for border styling
|
|
147
|
+
- Follow [spacing](../../design-language/spacing.md) for padding
|
|
177
148
|
|
|
178
149
|
---
|
|
179
150
|
|
|
@@ -199,9 +170,8 @@ See [foundations/logo.md](../../../foundations/logo.md) for logo guidelines.
|
|
|
199
170
|
|
|
200
171
|
## Related Documentation
|
|
201
172
|
|
|
202
|
-
- [
|
|
173
|
+
- [Reference home](../../README.md) - Brand and design language
|
|
203
174
|
- [Accessibility](./accessibility.md) - Technical accessibility implementation
|
|
204
175
|
- [Component Decision Tree](./component-decision-tree.md) - Component selection
|
|
205
|
-
- [
|
|
206
|
-
- [
|
|
207
|
-
- [Scenarios](./scenarios/) - Applied patterns for specific page types
|
|
176
|
+
- [Product Content](./content/product-content.md) - UX writing guidelines
|
|
177
|
+
- [Patterns](./patterns/) - Applied patterns for specific page types
|
|
@@ -4,12 +4,6 @@ Guidelines for Equal Experts transactional and product-related emails.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
**Status:** Placeholder - details to be defined
|
|
8
|
-
|
|
9
|
-
**Prerequisites:** Load [foundations](../../../foundations/) first
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
7
|
## Overview
|
|
14
8
|
|
|
15
9
|
Product emails are transactional communications sent from web applications, including confirmations, notifications, and system messages.
|
|
@@ -36,7 +30,7 @@ Product emails are transactional communications sent from web applications, incl
|
|
|
36
30
|
|
|
37
31
|
## Content Guidelines
|
|
38
32
|
|
|
39
|
-
Follow [foundations
|
|
33
|
+
Follow [content foundations](../../content/writing-style.md) and [product content](./content/product-content.md) for writing style.
|
|
40
34
|
|
|
41
35
|
### Subject Lines
|
|
42
36
|
- Be specific about the content
|
|
@@ -66,6 +60,6 @@ Follow [foundations/content/](../../../foundations/content/) and [product conten
|
|
|
66
60
|
|
|
67
61
|
## Related Documentation
|
|
68
62
|
|
|
69
|
-
- [
|
|
63
|
+
- [Reference home](../../README.md) - Brand and design language
|
|
70
64
|
- [Product Content](./content/product-content.md) - UX writing guidelines
|
|
71
|
-
- [Marketing Emails](../marketing/emails.md) - Marketing email guidelines
|
|
65
|
+
- [Marketing Emails](../web-marketing/emails.md) - Marketing email guidelines
|
package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/patterns/README.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Web Product Patterns
|
|
2
|
+
|
|
3
|
+
Applied layout and design patterns for web-application page types.
|
|
4
|
+
|
|
5
|
+
| Pattern | For | Base layout |
|
|
6
|
+
|---------|-----|-------------|
|
|
7
|
+
| [authentication.md](./authentication.md) | Login, registration, password flows, MFA | Single column |
|
|
8
|
+
| [dashboards.md](./dashboards.md) | Analytics, data tables, metrics, reporting | Sidebar navigation |
|
|
9
|
+
| [forms.md](./forms.md) | Settings, multi-step forms, data entry | Varies |
|
|
10
|
+
| [documentation.md](./documentation.md) | Docs sites, knowledge bases, API reference | Sidebar + split |
|
|
@@ -192,7 +192,7 @@ Authentication pages should minimise distraction and focus users on the task.
|
|
|
192
192
|
|
|
193
193
|
## Accessibility
|
|
194
194
|
|
|
195
|
-
**Base requirements:** See [foundations
|
|
195
|
+
**Base requirements:** See [accessibility foundations](../../../accessibility/accessibility.md) and [web accessibility](../accessibility.md)
|
|
196
196
|
|
|
197
197
|
**Scenario-specific:**
|
|
198
198
|
|
|
@@ -221,7 +221,7 @@ Follow the standard validation pattern:
|
|
|
221
221
|
|
|
222
222
|
### Button Placement
|
|
223
223
|
|
|
224
|
-
**Component guide:** `shadcn:button` — see [component-registry.md](../component-registry.md)
|
|
224
|
+
**Component guide:** `shadcn:button` — the `components/button.md` guide lives in the consumer package or overlay (see [component-registry.md](../component-registry.md)).
|
|
225
225
|
|
|
226
226
|
| Button | Position | Variant |
|
|
227
227
|
|--------|----------|---------|
|
|
@@ -300,4 +300,4 @@ Follow the standard validation pattern:
|
|
|
300
300
|
|
|
301
301
|
- [Product Design](../design.md) - Layout patterns
|
|
302
302
|
- [Web Accessibility](../accessibility.md) - Form validation pattern
|
|
303
|
-
- [Forms
|
|
303
|
+
- [Forms Pattern](./forms.md) - General form patterns
|