@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.
Files changed (73) hide show
  1. package/README.md +49 -49
  2. package/agent-docs/AGENTS.md +2 -2
  3. package/agent-docs/README.md +1 -1
  4. package/agent-docs/bundle-manifest.json +12 -20
  5. package/agent-docs/components/components.manifest.json +3 -0
  6. package/agent-docs/external/kuat-agent-rules/reference/accessibility/README.md +7 -0
  7. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/accessibility}/accessibility.md +12 -10
  8. package/agent-docs/external/kuat-agent-rules/reference/brand/README.md +9 -0
  9. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/brand.md +21 -11
  10. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference/brand}/logo.md +5 -4
  11. package/agent-docs/external/kuat-agent-rules/reference/brand/voice-and-tone.md +166 -0
  12. package/agent-docs/external/kuat-agent-rules/reference/content/README.md +12 -0
  13. package/agent-docs/external/kuat-agent-rules/reference/content/formatting.md +120 -0
  14. package/agent-docs/external/kuat-agent-rules/reference/content/numbers.md +87 -0
  15. package/agent-docs/external/kuat-agent-rules/reference/content/punctuation.md +94 -0
  16. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations → reference}/content/writing-style.md +7 -2
  17. package/agent-docs/external/kuat-agent-rules/reference/design-language/README.md +11 -0
  18. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/borders.md +3 -2
  19. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/colours.md +38 -10
  20. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/design-language.md +11 -10
  21. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/spacing.md +4 -3
  22. package/agent-docs/external/kuat-agent-rules/reference/design-language/tokens/README.md +29 -0
  23. package/agent-docs/external/kuat-agent-rules/reference/design-language/tokens/colors.tokens.json +84 -0
  24. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/foundations/design → reference/design-language}/typography.md +5 -4
  25. package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/README.md +10 -0
  26. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/README.md +2 -2
  27. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/blog-posts.md +1 -5
  28. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/marketing-content.md +2 -6
  29. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/content/seo.md +2 -6
  30. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/emails.md +3 -9
  31. package/agent-docs/external/kuat-agent-rules/reference/media-types/web-marketing/patterns/README.md +7 -0
  32. 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
  33. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/marketing → reference/media-types/web-marketing}/website.md +7 -22
  34. package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/README.md +16 -0
  35. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/accessibility.md +2 -12
  36. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/component-decision-tree.md +3 -18
  37. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/component-registry.md +3 -22
  38. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/README.md +2 -2
  39. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/actions.md +1 -7
  40. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/confirmations.md +0 -6
  41. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/empty-states.md +0 -6
  42. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/errors.md +0 -6
  43. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/forms.md +1 -7
  44. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/content/product-content.md +1 -11
  45. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/design.md +6 -36
  46. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product → reference/media-types/web-product}/emails.md +3 -9
  47. package/agent-docs/external/kuat-agent-rules/reference/media-types/web-product/patterns/README.md +10 -0
  48. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/authentication.md +3 -3
  49. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/dashboards.md +2 -2
  50. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/documentation.md +3 -3
  51. package/agent-docs/external/kuat-agent-rules/{kuat-docs/rules/types/web/product/scenarios → reference/media-types/web-product/patterns}/forms.md +3 -3
  52. package/agent-docs/kuat-docs/rules/README.md +37 -30
  53. package/agent-docs/kuat-docs/rules/design/layouts.md +1 -1
  54. package/agent-docs/kuat-docs/rules/scenarios/README.md +1 -1
  55. package/agent-docs/manifest.json +3 -3
  56. package/agent-docs/rules/LOADING-consumer.md +5 -5
  57. package/dist/components/ui/carousel/carousel.d.ts +1 -1
  58. package/dist/style.css +1 -1
  59. package/package.json +2 -2
  60. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/LOADING.md +0 -166
  61. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/README.md +0 -28
  62. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/formatting.md +0 -93
  63. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/numbers.md +0 -69
  64. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/punctuation.md +0 -75
  65. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/content/voice-and-tone.md +0 -263
  66. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/foundations/design/README.md +0 -28
  67. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/marketing/scenarios/README.md +0 -18
  68. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/DEPRECATIONS.md +0 -28
  69. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/README.md +0 -65
  70. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/review-checklist.md +0 -57
  71. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/review-context.md +0 -44
  72. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/scenarios/README.md +0 -82
  73. package/agent-docs/external/kuat-agent-rules/kuat-docs/rules/types/web/product/technical.md +0 -488
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@equal-experts/kuat-react",
3
- "version": "0.13.1",
3
+ "version": "0.14.0-beta.1",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.js",
@@ -107,7 +107,7 @@
107
107
  "license": "MIT",
108
108
  "repository": {
109
109
  "type": "git",
110
- "url": "https://github.com/your-org/kuat-mono.git",
110
+ "url": "https://github.com/equalexperts/kuat-mono.git",
111
111
  "directory": "packages/kuat-react"
112
112
  },
113
113
  "scripts": {
@@ -1,166 +0,0 @@
1
- # Agent Rules Loading Index
2
-
3
- **Canonical reference** for which rule files to load for each task type. Use this index to resolve "task X" → exact list of files. All paths are relative to `kuat-docs/rules/`.
4
-
5
- ---
6
-
7
- ## Intent (review | create)
8
-
9
- Determine intent before loading type rules. If unclear, ask: *Are you reviewing existing work or creating something new?*
10
-
11
- | Intent | Load first | Then |
12
- |--------|------------|------|
13
- | **review** | Skill [kuat-review](../../skills/kuat-review/SKILL.md) — run [ensure-rules](../../skills/scripts/ensure-rules.sh) | foundations → [roles/brand-reviewer.md](./roles/brand-reviewer.md) → type rules (see [Review load notes](#review-load-notes)) |
14
- | **create** | Skill [kuat-create](../../skills/kuat-create/SKILL.md) — run [ensure-rules](../../skills/scripts/ensure-rules.sh) | foundations → create role card if any → type rules → scenarios/examples as needed |
15
-
16
- ---
17
-
18
- ## Load order
19
-
20
- 1. **Determine intent** (review | create) and load the matching [skill](../../skills/) (`kuat-review` or `kuat-create`); resolve rules via [skills/shared/resolve-rules.md](../../skills/shared/resolve-rules.md).
21
- 2. **Always load foundations** (see [Foundations](#foundations) below).
22
- 3. **Load the role card** for the intent: [brand-reviewer](./roles/brand-reviewer.md) for review; task-specific role for create when listed in [Role cards](#role-cards).
23
- 4. **Then load type-specific rules** for the task (see [Task → rules](#task--rules)).
24
- 5. **Optionally** add scenarios or examples when relevant (see [Optional paths](#optional-paths)).
25
-
26
- **Platform isolation:** Type-specific rules must not reference other types. Foundations are shared; types only reference foundations.
27
-
28
- ## Entry points
29
-
30
- | Entry | Audience | Start | Index file |
31
- |-------|----------|-------|------------|
32
- | **Org** | Brand, slides, all platforms | [AGENTS.md](../../AGENTS.md) | This file (`LOADING.md`) |
33
- | **Library** | `kuat-mono` contributors | Mono `AGENTS.md` | This file + mono `kuat-docs/LOADING.md` overlay |
34
- | **App** | npm consumers | `node_modules/@equal-experts/kuat-react/agent-docs/AGENTS.md` | `agent-docs/rules/LOADING-consumer.md` (generated on publish) |
35
-
36
- Full architecture: [setup/consumption-architecture.md](../setup/consumption-architecture.md).
37
-
38
- Run [ensure-rules.sh](../../skills/scripts/ensure-rules.sh) — emits `RULES_SOURCE=git|package` and optional `OVERLAY_DIR`.
39
-
40
- ## Cross-repo consumption contract
41
-
42
- When these rules are used from a consumer implementation repo (for example `kuat-mono`) or via npm packages:
43
-
44
- 1. Resolve rules: git `kuat-agent-docs` or bundled `agent-docs` in `@equal-experts/kuat-react` / `kuat-vue`.
45
- 2. Load local implementation overlay second when `KUAT_RULES_OVERLAY_PATH` is set.
46
-
47
- Conflict policy:
48
- - Design/structure/content guidance -> upstream rules or bundled snapshot at package version.
49
- - Implementation/API/testing/build -> local implementation repo or package component docs.
50
- - If implementation behavior remains ambiguous, trust runtime evidence in this order: tests, Storybook, package exports, source code.
51
-
52
- Ownership: [setup/ownership-matrix.md](../setup/ownership-matrix.md).
53
-
54
- ---
55
-
56
- ## Foundations
57
-
58
- **Path:** `foundations/`
59
-
60
- **Shared (top level):**
61
- | File | Description |
62
- |------|-------------|
63
- | `foundations/brand.md` | Brand principles and identity |
64
- | `foundations/logo.md` | Logo variants, sizing, placement |
65
- | `foundations/accessibility.md` | Accessibility principles and guidelines |
66
-
67
- **Design** (`foundations/design/`):
68
- | File | Description |
69
- |------|-------------|
70
- | `foundations/design/design-language.md` | Design principles |
71
- | `foundations/design/colours.md` | Brand color palette |
72
- | `foundations/design/typography.md` | Fonts and type scale |
73
- | `foundations/design/spacing.md` | Spacing system |
74
- | `foundations/design/borders.md` | Border philosophy |
75
-
76
- **Content** (`foundations/content/`):
77
- | File | Description |
78
- |------|-------------|
79
- | `foundations/content/voice-and-tone.md` | Voice, tone, audience, quality checklist |
80
- | `foundations/content/writing-style.md` | Active voice, plain language, conciseness |
81
- | `foundations/content/formatting.md` | Capitalisation, headings, links, lists |
82
- | `foundations/content/numbers.md` | Dates, times, currency, units |
83
- | `foundations/content/punctuation.md` | Punctuation conventions |
84
-
85
- **When to load:** For minimal context, load only the foundation file(s) relevant to the task. For standard or full context, load all of `foundations/` (shared + design + content as needed, ~800+ lines).
86
-
87
- ---
88
-
89
- ## Role cards
90
-
91
- **Path:** `roles/`
92
-
93
- Load after foundations (or inject as the first instruction block). Task → role mapping: [roles/README.md](./roles/README.md).
94
-
95
- | Intent | Role card |
96
- |--------|-----------|
97
- | **review** (all task types) | [roles/brand-reviewer.md](./roles/brand-reviewer.md) |
98
-
99
- | Task type (create) | Role card |
100
- |--------------------|-----------|
101
- | infographics | [roles/technical-illustrator.md](./roles/technical-illustrator.md) |
102
- | icons | [roles/icon-designer.md](./roles/icon-designer.md) |
103
-
104
- ---
105
-
106
- ## Task → rules
107
-
108
- | Task type | Required foundations | Required type-specific | Notes |
109
- |-----------|----------------------|------------------------|--------|
110
- | **slides** | All foundations (or: brand, logo, design, content) | `types/slides/` | Full rule set: brand-compliance, styling, layouts, content, imagery-and-diagrams, data, checklist; scenarios when deck type is known. |
111
- | **photography** | brand (or all foundations) | `types/photography/` | Full rule set: principles, diversity-inclusion, style-and-sources, quality-validation. |
112
- | **icons** | brand, design/colours (or all foundations) | `types/graphics/icons.md` | Single file. |
113
- | **illustrations** | brand, design/colours, design/typography (or all foundations) | `types/graphics/illustrations.md` | Single file. |
114
- | **infographics** | brand, design/colours, design/typography, design/spacing (or all foundations) | `types/graphics/infographics.md` | Single file. |
115
- | **charts_data** | design/colours, design/typography (or all foundations) | `types/charts-data/` | Placeholder/skeleton; has minimal chart-type guidance. |
116
- | **web_marketing** | All foundations | `types/web/marketing/` | Include scenarios when designing specific marketing page types; content in `types/web/marketing/content/`. |
117
- | **web_product** | All foundations | `types/web/product/` | Include scenarios for docs, forms, dashboards, auth; content in `types/web/product/content/`; include examples when implementing in React/Vue/CSS. |
118
-
119
- ---
120
-
121
- ## Review load notes
122
-
123
- When intent is **review**, use these load deltas (in addition to skill [kuat-review](../../skills/kuat-review/SKILL.md)):
124
-
125
- | Task type | Load | Skip |
126
- |-----------|------|------|
127
- | **slides** | All `types/slides/` core files + [checklist.md](./types/slides/checklist.md); scenario if deck type known | — |
128
- | **web_product** | [design.md](./types/web/product/design.md), [accessibility.md](./types/web/product/accessibility.md), [component-decision-tree.md](./types/web/product/component-decision-tree.md), [review-context.md](./types/web/product/review-context.md), [review-checklist.md](./types/web/product/review-checklist.md); relevant scenario if flow type known | `types/web/product/examples/` |
129
- | **Others** | Foundations + type README + any validation checklist (e.g. photography `quality-validation.md`) | Implementation examples unless reviewing code |
130
-
131
- ---
132
-
133
- ## Optional paths
134
-
135
- | Path | When to include |
136
- |------|------------------|
137
- | `types/slides/scenarios/` | Deck type known (sales, knowledge sharing, case study, reporting). |
138
- | `types/photography/` | Selecting or reviewing slide photography beyond placement rules. |
139
- | `types/charts-data/` | Building or restyling complex charts for slides. |
140
- | `types/web/marketing/scenarios/` | Task involves specific marketing page types (see scenarios README). |
141
- | `types/web/marketing/content/` | Task involves marketing copy, blog, or SEO. |
142
- | `types/web/product/scenarios/` | Task involves documentation pages, forms, dashboards, or authentication flows. |
143
- | `types/web/product/content/` | Task involves product UX writing (actions, errors, forms, etc.). |
144
- | `types/web/product/examples/` | **Create only:** implementing web product UI in React, Vue, or vanilla CSS. **Do not load for review.** Prefer component IDs + package/overlay docs (see [DEPRECATIONS.md](./types/web/product/DEPRECATIONS.md)). |
145
- | Component guides (`components/{slug}.md`) | Artifact or scenario cites a component ID ([component-registry.md](./types/web/product/component-registry.md)). Resolve via `COMPONENT_MANIFEST` from package `agent-docs/` or `KUAT_RULES_OVERLAY_PATH`. Load on demand, not the full catalog. |
146
-
147
- ---
148
-
149
- ## Context size reference
150
-
151
- | Level | What to load | Approx. size |
152
- |-------|----------------|--------------|
153
- | Minimal | Single foundation file (e.g. `foundations/design/colours.md`) | ~100 lines |
154
- | Standard | All `foundations/` | ~800 lines |
155
- | Full (web product) | `foundations/` + `types/web/product/` | ~2000 lines |
156
- | Full (web product + examples) | Above + `types/web/product/examples/` | ~3500 lines |
157
-
158
- ---
159
-
160
- ## Related
161
-
162
- - [skills/](../../skills/) – Review and create skills (orchestration)
163
- - [workflows/](./workflows/) – Pointer to skills (legacy path)
164
- - [rules/README.md](./README.md) – Structure and overview
165
- - [AGENTS.md](../../AGENTS.md) – Agent entry point and behaviour guidelines
166
- - [setup/integration.md](../../setup/integration.md) – IDE integration
@@ -1,28 +0,0 @@
1
- # Content Rules
2
-
3
- Writing style, voice, tone, and usage for Equal Experts. Apply to all content before platform-specific guidance.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- These rules cover how we write: voice and tone, style principles, formatting, numbers, and punctuation. Load [voice-and-tone.md](./voice-and-tone.md) first; use the others as needed for the task.
10
-
11
- ---
12
-
13
- ## Files
14
-
15
- | File | Description |
16
- |------|-------------|
17
- | [voice-and-tone.md](./voice-and-tone.md) | Voice, tone, audience, quality checklist, AI content |
18
- | [writing-style.md](./writing-style.md) | Active voice, plain language, contractions, conciseness |
19
- | [formatting.md](./formatting.md) | Capitalisation, bold/italic, headings, links, lists, acronyms |
20
- | [numbers.md](./numbers.md) | Dates, times, currency, percentages, units |
21
- | [punctuation.md](./punctuation.md) | Commas, dashes, apostrophes, quotation marks |
22
-
23
- ---
24
-
25
- ## Related
26
-
27
- - [Foundations](../README.md) – Brand, logo, accessibility
28
- - [Design](../design/README.md) – Visual design and tokens
@@ -1,93 +0,0 @@
1
- # Formatting
2
-
3
- How to use bold, capitalisation, headings, links, lists, and abbreviations in Equal Experts content.
4
-
5
- ---
6
-
7
- ## Quick Reference
8
-
9
- - **Capitalisation:** Sentence case for headings, buttons, and body copy; title case only for proper nouns and product names
10
- - **Bold:** Use sparingly for emphasis or key terms
11
- - **Links:** Descriptive link text, not "click here" or raw URLs
12
- - **Lists:** Use when items are parallel; keep items concise
13
- - **Acronyms:** Spell out on first use, then use the short form
14
-
15
- ---
16
-
17
- ## Capitalisation
18
-
19
- ### Sentence case
20
-
21
- Use sentence case for:
22
- - Headings and subheadings
23
- - Button and link labels
24
- - List items
25
- - Body copy
26
-
27
- **Examples:**
28
- "Getting started"
29
- "Save and continue"
30
- "Contact the team"
31
-
32
- ### Title case
33
-
34
- Reserve for:
35
- - Proper nouns (Equal Experts, product names)
36
- - Official titles when they are the full name of something
37
-
38
- Do not use title case for general headings or UI labels.
39
-
40
- ---
41
-
42
- ## Bold and Italic
43
-
44
- - **Bold:** Use for a small number of key terms or one-off emphasis. Don't bold whole sentences or paragraphs.
45
- - *Italic:* Use for titles of works, technical terms on first use if needed, or subtle emphasis. Use sparingly in UI copy.
46
-
47
- ---
48
-
49
- ## Headings
50
-
51
- - One H1 per page or screen (the main title)
52
- - Use a logical hierarchy: H1 → H2 → H3; don't skip levels
53
- - Make headings descriptive so they work as a scan of the content
54
- - Prefer sentence case
55
-
56
- ---
57
-
58
- ## Links
59
-
60
- - Link text should describe the destination or action
61
- - Avoid "click here", "read more", "learn more" without context
62
-
63
- | Prefer | Avoid |
64
- |--------|--------|
65
- | Read the accessibility guidelines | Click here for guidelines |
66
- | Pricing plans | Learn more |
67
- | Contact the team | https://example.com/contact |
68
-
69
- ---
70
-
71
- ## Lists
72
-
73
- - Use bullet lists for unordered items
74
- - Use numbered lists for steps or ranked items
75
- - Keep list items parallel in structure
76
- - Start with a lead-in sentence if it helps; don't repeat the same lead-in word in every item when not needed
77
- - Prefer sentence case and consistent punctuation (full stops only if items are full sentences)
78
-
79
- ---
80
-
81
- ## Abbreviations and Acronyms
82
-
83
- - Spell out on first use with the short form in parentheses: "Application Programming Interface (API)"
84
- - Use the short form consistently after that
85
- - For well-known terms in your audience (e.g. API, UX), first-use expansion is still helpful in public-facing or mixed-audience content
86
-
87
- ---
88
-
89
- ## Related Documentation
90
-
91
- - [Voice and tone](./voice-and-tone.md)
92
- - [Writing style](./writing-style.md)
93
- - [Numbers](./numbers.md) - Dates, currency, units
@@ -1,69 +0,0 @@
1
- # Numbers
2
-
3
- Guidance for dates, times, currency, and other numbers in Equal Experts content.
4
-
5
- ---
6
-
7
- ## Quick Reference
8
-
9
- - **Dates:** Use a clear, unambiguous format; prefer written or ISO (YYYY-MM-DD) depending on context
10
- - **Times:** Use 24-hour or am/pm consistently; specify time zone when relevant
11
- - **Currency:** Use symbol or code (e.g. £, GBP) as appropriate; be consistent within a document
12
- - **Percentages:** Use the % symbol with the number (e.g. 45%)
13
- - **Large numbers:** Use commas (or spaces in some locales) for thousands
14
-
15
- ---
16
-
17
- ## Dates
18
-
19
- - Prefer a format that avoids ambiguity (e.g. 24 March 2025 or 2025-03-24)
20
- - In UK-facing content, day–month–year is standard (24 March 2025)
21
- - In technical or international contexts, ISO 8601 (YYYY-MM-DD) is often clearer
22
- - Spell out month names in body copy when space allows; abbreviate only in tables or tight UI (e.g. Mar 2025)
23
-
24
- ---
25
-
26
- ## Time
27
-
28
- - Be consistent within a document: either 24-hour (14:30) or 12-hour with am/pm (2:30 pm)
29
- - Specify time zone when the reader needs to act or compare across regions (e.g. "2:30 pm GMT")
30
- - Use "midday" and "midnight" where they're clearer than 12:00
31
-
32
- ---
33
-
34
- ## Currency
35
-
36
- - Use the appropriate symbol (£, $, €) or ISO code (GBP, USD, EUR) as fits the context
37
- - Be consistent: don't mix "£10" and "10 GBP" in the same piece unless one is clearly a label
38
- - For whole amounts, no decimal places unless it's pence/cents (e.g. £10 not £10.00 for ten pounds)
39
-
40
- ---
41
-
42
- ## Percentages
43
-
44
- - Use the % symbol with the number: 45%, 12.5%
45
- - In body copy, "45%" is usually preferable to "45 percent" unless you're writing for voice or very formal copy
46
- - For a range, "40–60%" (en dash, no space)
47
-
48
- ---
49
-
50
- ## Units of Measure
51
-
52
- - Use metric by default in UK/international content unless the audience or product uses imperial
53
- - Abbreviate when standard: kg, m, km, cm. Spell out in prose when it reads more naturally
54
- - Leave a space between number and unit: "5 kg", "12 cm"
55
-
56
- ---
57
-
58
- ## Large Numbers
59
-
60
- - Use commas as thousand separators in English (1,000,000) or a thin space where that's the convention
61
- - Keep formatting consistent in tables and lists
62
- - For very large numbers, consider "1.5 million" or "2.3 billion" in body copy
63
-
64
- ---
65
-
66
- ## Related Documentation
67
-
68
- - [Formatting](./formatting.md) - Capitalisation, lists
69
- - [Punctuation](./punctuation.md) - Dashes, spaces
@@ -1,75 +0,0 @@
1
- # Punctuation
2
-
3
- Guidance for commas, dashes, apostrophes, and other punctuation in Equal Experts content.
4
-
5
- ---
6
-
7
- ## Quick Reference
8
-
9
- - **Commas:** Use to separate clauses and items in a list; avoid comma splices
10
- - **Apostrophes:** Use for possessives and contractions; don't use for plurals
11
- - **Dashes:** Use en dash for ranges (40–60); use em dash sparingly for a break in a sentence
12
- - **Hyphens:** Use in compound modifiers before a noun (e.g. well-known); follow standard compound rules
13
- - **Exclamation points:** Use rarely; one is enough
14
-
15
- ---
16
-
17
- ## Commas
18
-
19
- - Use a comma before "and" or "or" in a list of three or more items (Oxford comma) for clarity when it avoids ambiguity
20
- - Use commas to set off non-essential clauses
21
- - Don't join two independent clauses with only a comma (use a full stop, semicolon, or conjunction)
22
-
23
- ---
24
-
25
- ## Apostrophes
26
-
27
- - **Possessives:** Add 's for singular (team's, user's); add ' for plural already ending in s (users', teams')
28
- - **Contractions:** Use for standard contractions (don't, it's, we're)
29
- - **Plurals:** Do not use an apostrophe for plurals: "1990s" not "1990's"; "APIs" not "API's"
30
-
31
- ---
32
-
33
- ## Dashes and Hyphens
34
-
35
- - **En dash (–):** Use for ranges (40–60%, March–May, 9–5). Use unspaced in British style.
36
- - **Em dash (—):** Use sparingly for a strong break or aside. Prefer one em dash per sentence.
37
- - **Hyphen (-):** Use in compound modifiers before a noun: "well-known result", "up-to-date report". Don't hyphenate after the noun when the modifier follows: "the result is well known".
38
- - **Hyphen in compounds:** Follow standard usage (e.g. "email", "multi-factor", "read-only" as per common style)
39
-
40
- ---
41
-
42
- ## Colons and Semicolons
43
-
44
- - **Colon:** Use to introduce a list or an explanation that follows from the main clause. One space after a colon.
45
- - **Semicolon:** Use to link closely related independent clauses, or to separate list items that already contain commas. Use sparingly; often a full stop is clearer.
46
-
47
- ---
48
-
49
- ## Ellipses
50
-
51
- - Use for omitted words in a quote (three dots: …)
52
- - Avoid in UI or body copy to indicate "more" or trailing thought; rewrite so the sentence is complete
53
-
54
- ---
55
-
56
- ## Exclamation Points
57
-
58
- - Use rarely; reserve for genuine emphasis or short, positive confirmation
59
- - One exclamation point is enough; never use multiple (!!)
60
-
61
- ---
62
-
63
- ## Quotation Marks
64
-
65
- - Use double quotation marks for direct speech and short quoted phrases
66
- - Put full stops and commas inside the closing quote when they apply to the quoted matter; outside when they apply to the whole sentence (British style)
67
- - For terms or "scare quotes", use sparingly
68
-
69
- ---
70
-
71
- ## Related Documentation
72
-
73
- - [Writing style](./writing-style.md)
74
- - [Formatting](./formatting.md)
75
- - [Numbers](./numbers.md) - Ranges, decimals