Skip to content

Commit f9d7daf

Browse files
Merge pull request #157 from jeffreylauwers/docs/remove-em-dashes
docs: vervang em dashes door dubbele punten in alle documentatie
2 parents 540876b + f5cec94 commit f9d7daf

80 files changed

Lines changed: 1304 additions & 1309 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/commands/new-component-issue.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Nieuw component issue aanmaken
22

3-
Maak een nieuw GitHub issue aan voor een **nieuw design system component**. Het issue volgt het vaste componentspec-formaat inclusief HTML/CSS-structuur, React API, toegankelijkheidsvereisten en component tokens.
3+
Maak een nieuw GitHub issue aan voor een **nieuw design system component**. Het issue volgt het vaste componentspec-formaat: inclusief HTML/CSS-structuur, React API, toegankelijkheidsvereisten en component tokens.
44

55
Optionele context meegegeven door de gebruiker (componentnaam, beschrijving, etc.):
66

77
> $ARGUMENTS
88
99
---
1010

11-
## Stap 1 Componentnaam en beschrijving
11+
## Stap 1: Componentnaam en beschrijving
1212

1313
Als `$ARGUMENTS` geen componentnaam bevat, vraag dan:
1414

@@ -19,15 +19,15 @@ Stel de titel op: `feat(ComponentName): korte beschrijving`
1919

2020
---
2121

22-
## Stap 2 Verzamel de spec
22+
## Stap 2: Verzamel de spec
2323

24-
Vraag de gebruiker naar de volgende onderdelen. Meerdere secties mogen in één keer worden aangeleverd; sluit geen enkel onderdeel over gebruik HTML-commentaren als er niets is.
24+
Vraag de gebruiker naar de volgende onderdelen. Meerdere secties mogen in één keer worden aangeleverd; sluit geen enkel onderdeel over: gebruik HTML-commentaren als er niets is.
2525

2626
### 2a. Beschrijving en gebruik
2727

2828
- **Beschrijving**: Wat doet het component en wanneer gebruik je het? (2–4 zinnen)
29-
- **Gebruik wanneer wél**: 3–5 bulletpunten
30-
- **Gebruik wanneer niet**: 1–2 gevallen waarbij een alternatief beter is
29+
- **Gebruik: wanneer wél**: 3–5 bulletpunten
30+
- **Gebruik: wanneer niet**: 1–2 gevallen waarbij een alternatief beter is
3131

3232
### 2b. HTML/CSS implementatie
3333

@@ -40,8 +40,8 @@ Vraag de gebruiker naar de volgende onderdelen. Meerdere secties mogen in één
4040
> - Modifier altijd naast basisklasse: `class="dsn-note dsn-note--info"`
4141
> - Grootte via `--size-{naam}`: `dsn-button--size-small`
4242
> - Geen geneste element-namen: `dsn-alert__content__text`
43-
> - Nooit `aria-label` op buttons altijd `dsn-button__label` span
44-
> - Nooit hardcoded waarden in CSS altijd `var(--dsn-*)`
43+
> - Nooit `aria-label` op buttons: altijd `dsn-button__label` span
44+
> - Nooit hardcoded waarden in CSS: altijd `var(--dsn-*)`
4545
4646
### 2c. React component
4747

@@ -64,18 +64,18 @@ Vraag specifiek naar:
6464
- Ontwerpkeuzes achter de tokenwaarden (1–3 regels per niet-voor-de-hand-liggende keuze)
6565
- Markeer onzekere waarden met een ⚠️ opmerking
6666

67-
> **Token schrijfwijze altijd controleren:**
67+
> **Token schrijfwijze: altijd controleren:**
6868
> Sub-groepen (zoals `icon`, `label`, `control`) worden als geneste objecten geschreven, niet als geflattende sleutels met koppeltekens:
6969
>
7070
> ```json
71-
> // ✅ Correct geneste structuur
71+
> // ✅ Correct: geneste structuur
7272
> "icon": {
7373
> "color": { "value": "...", "type": "color" },
7474
> "size": { "value": "...", "type": "dimension" },
7575
> "gap": { "value": "...", "type": "spacing" }
7676
> }
7777
>
78-
> // ❌ Fout geflattend
78+
> // ❌ Fout: geflattend
7979
> "icon-color": { "value": "...", "type": "color" },
8080
> "icon-size": { "value": "...", "type": "dimension" }
8181
> ```
@@ -85,7 +85,7 @@ Vraag specifiek naar:
8585
8686
---
8787
88-
## Stap 3 Stel de issue body samen
88+
## Stap 3: Stel de issue body samen
8989
9090
Bouw de body op in deze volgorde. Vul in wat de gebruiker aanleverde; gebruik HTML-commentaren voor ontbrekende informatie.
9191
@@ -152,7 +152,7 @@ Het [ComponentName] component wordt gebruikt voor:
152152

153153
## Component tokens (voorstel)
154154

155-
> ⚠️ **Review vereist vóór implementatie** akkoord geven op deze tabel voordat de bouw begint.
155+
> ⚠️ **Review vereist vóór implementatie**: akkoord geven op deze tabel voordat de bouw begint.
156156
157157
```json
158158
{
@@ -189,11 +189,11 @@ Het [ComponentName] component wordt gebruikt voor:
189189
### Storybook
190190

191191
- [ ] Drie bestanden aangemaakt: `.stories.tsx`, `.docs.mdx`, `.docs.md`
192-
- [ ] `// DEFAULT` sectie `Default` story
193-
- [ ] `// VARIANTEN` sectie per-prop/state stories (bijv. `WithDescription`, `Disabled`, `Invalid`)
194-
- [ ] `// OVERZICHTSSTORIES` sectie `AllVariants` of `AllStates` (zie regel hieronder)
195-
- [ ] `// TEKST VARIANTEN` sectie `ShortText` + `LongText` (alleen bij componenten met zichtbare tekstinhoud)
196-
- [ ] `// RTL` sectie `RTL` + `RTLLongText` (alleen bij componenten met tekst of richtingsgevoelige layout)
192+
- [ ] `// DEFAULT` sectie: `Default` story
193+
- [ ] `// VARIANTEN` sectie: per-prop/state stories (bijv. `WithDescription`, `Disabled`, `Invalid`)
194+
- [ ] `// OVERZICHTSSTORIES` sectie: `AllVariants` of `AllStates` (zie regel hieronder)
195+
- [ ] `// TEKST VARIANTEN` sectie: `ShortText` + `LongText` (alleen bij componenten met zichtbare tekstinhoud)
196+
- [ ] `// RTL` sectie: `RTL` + `RTLLongText` (alleen bij componenten met tekst of richtingsgevoelige layout)
197197
- [ ] Alle story-namen in het Engels
198198

199199
---
@@ -238,31 +238,31 @@ Het [ComponentName] component wordt gebruikt voor:
238238
````
239239
240240
**Let op bij het invullen:**
241-
- Acceptatiecriteria **genereer je** op basis van wat de gebruiker in stap 2 heeft opgegeven maak ze concreet en specifiek
241+
- Acceptatiecriteria **genereer je** op basis van wat de gebruiker in stap 2 heeft opgegeven: maak ze concreet en specifiek
242242
- Storybook stories leiden af uit de HTML/CSS-varianten die beschreven zijn
243243
- Ontbrekende secties krijgen een HTML-commentaar, niet worden weggelaten
244244
- Tokens die nog niet bepaald zijn, markeer je expliciet met een ⚠️-opmerking in de Notities sectie
245245
246-
**Storybook story-structuur vaste regels:**
246+
**Storybook story-structuur: vaste regels:**
247247
248248
Elke `.stories.tsx` volgt altijd deze sectievolgorde (met `// ===` comments als scheidslijn):
249249
250-
1. `// DEFAULT` altijd één `Default` story
251-
2. `// VARIANTEN` individuele stories per prop of state
252-
3. `// OVERZICHTSSTORIES` één overzichtsstory:
250+
1. `// DEFAULT`: altijd één `Default` story
251+
2. `// VARIANTEN`: individuele stories per prop of state
252+
3. `// OVERZICHTSSTORIES`: één overzichtsstory:
253253
- `AllVariants` / `'All variants'` → voor componenten met **visuele kleur- of stijlvarianten** (bijv. `variant="info|warning|error"`)
254254
- `AllStates` / `'All states'` → voor componenten met **interactieve states** (bijv. default, disabled, invalid, read-only)
255-
4. `// TEKST VARIANTEN``ShortText` + `LongText` **alleen** bij componenten met zichtbare tekstinhoud; weglaten bij icoon-only of puur visuele componenten (DotBadge, Icon, Checkbox, Radio)
256-
5. `// RTL``RTL` + `RTLLongText` **alleen** bij componenten met tekst of richtingsgevoelige layout
255+
4. `// TEKST VARIANTEN`: `ShortText` + `LongText`: **alleen** bij componenten met zichtbare tekstinhoud; weglaten bij icoon-only of puur visuele componenten (DotBadge, Icon, Checkbox, Radio)
256+
5. `// RTL`: `RTL` + `RTLLongText`: **alleen** bij componenten met tekst of richtingsgevoelige layout
257257
258-
Geen `// HIGH CONTRAST` sectie daar zijn we van af gestapt.
258+
Geen `// HIGH CONTRAST` sectie: daar zijn we van af gestapt.
259259
260-
**Story `name:` properties altijd Engels:**
260+
**Story `name:` properties: altijd Engels:**
261261
262-
De `export const` naam en de optionele `name:` string in het story-object moeten **altijd Engels** zijn. Dit geldt ook als de `export const` naam zichzelf al beschrijft gebruik dan géén `name:` property.
262+
De `export const` naam en de optionele `name:` string in het story-object moeten **altijd Engels** zijn. Dit geldt ook als de `export const` naam zichzelf al beschrijft: gebruik dan géén `name:` property.
263263
264264
```ts
265-
// ✅ Correct Engelse name property
265+
// ✅ Correct: Engelse name property
266266
export const WithIconStart: Story = {
267267
name: 'With icon start',
268268
// ...
@@ -278,7 +278,7 @@ export const Current: Story = {
278278
// ...
279279
};
280280
281-
// ❌ Fout Nederlandse name property
281+
// ❌ Fout: Nederlandse name property
282282
export const WithIconStart: Story = {
283283
name: 'Met icoon start', // ❌
284284
};
@@ -299,13 +299,13 @@ Veelgebruikte Engelse vertalingen:
299299
300300
---
301301
302-
## Stap 4 Toon ter review
302+
## Stap 4: Toon ter review
303303
304304
Laat de volledige title én body zien aan de gebruiker. Vraag om expliciete bevestiging voordat het issue aangemaakt wordt.
305305
306306
---
307307
308-
## Stap 5 Maak het issue aan
308+
## Stap 5: Maak het issue aan
309309
310310
Na bevestiging van de gebruiker:
311311
@@ -322,11 +322,11 @@ Rapporteer de URL van het aangemaakte issue.
322322

323323
## Regels
324324

325-
- Gebruik **altijd** het volledige template sla geen secties over
326-
- **Genereer** de acceptatiecriteria op basis van de spec kopieer ze niet blind uit eerdere issues
327-
- Voeg **geen** verzonnen implementatiedetails toe als iets onbekend is, gebruik HTML-commentaar of ⚠️
325+
- Gebruik **altijd** het volledige template: sla geen secties over
326+
- **Genereer** de acceptatiecriteria op basis van de spec: kopieer ze niet blind uit eerdere issues
327+
- Voeg **geen** verzonnen implementatiedetails toe: als iets onbekend is, gebruik HTML-commentaar of ⚠️
328328
- Vraag altijd om **expliciete bevestiging** voordat het issue aangemaakt wordt
329-
- Labels zijn altijd `feat,component,needs refinement` geen uitzonderingen voor nieuwe componenten
330-
- **Geen Figma-verwijzingen** er is geen Figma in dit project; schrijf nooit "valideren in Figma", "zie Figma" of soortgelijke verwijzingen
331-
- **Token schrijfwijze** controleer altijd of sub-groepen als geneste objecten zijn geschreven (zie stap 2e)
332-
- **Story namen altijd Engels** zowel `export const` namen als `name:` properties in story-objecten zijn altijd Engelstalig; Nederlandse `name:` properties zijn een bug (zie voorbeelden in de Storybook story-structuur sectie hierboven)
329+
- Labels zijn altijd `feat,component,needs refinement`: geen uitzonderingen voor nieuwe componenten
330+
- **Geen Figma-verwijzingen**: er is geen Figma in dit project; schrijf nooit "valideren in Figma", "zie Figma" of soortgelijke verwijzingen
331+
- **Token schrijfwijze**: controleer altijd of sub-groepen als geneste objecten zijn geschreven (zie stap 2e)
332+
- **Story namen altijd Engels**: zowel `export const` namen als `name:` properties in story-objecten zijn altijd Engelstalig; Nederlandse `name:` properties zijn een bug (zie voorbeelden in de Storybook story-structuur sectie hierboven)

.claude/commands/new-issue.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Nieuw backlog item aanmaken
22

3-
Maak een nieuw GitHub issue aan als backlog item. Het issue **moet altijd** het standaard template volgen sla geen secties over.
3+
Maak een nieuw GitHub issue aan als backlog item. Het issue **moet altijd** het standaard template volgen: sla geen secties over.
44

55
Optionele context meegegeven door de gebruiker (componentnaam, beschrijving, etc.):
66

77
> $ARGUMENTS
88
99
---
1010

11-
## Stap 1 Bepaal titel en scope
11+
## Stap 1: Bepaal titel en scope
1212

1313
Als de gebruiker geen componentnaam of beschrijving heeft meegegeven via `$ARGUMENTS`, vraag dan:
1414

@@ -23,20 +23,20 @@ Bepaal het juiste titelformaat:
2323

2424
---
2525

26-
## Stap 2 Verzamel de template-inhoud
26+
## Stap 2: Verzamel de template-inhoud
2727

2828
Vraag de gebruiker naar de volgende onderdelen (gebruik `AskUserQuestion` of vraag ze één voor één via tekst):
2929

30-
1. **User Story** "Als [gebruiker/ontwikkelaar] wil ik [wat] zodat [waarom]."
31-
2. **Context** Technische context, gerelateerde issues of code. (optioneel)
32-
3. **Acceptance Criteria** De concrete done-criteria. (één per regel)
33-
4. **Notities / Open vragen** Edge cases, twijfels, refinement-punten. (optioneel)
30+
1. **User Story**: "Als [gebruiker/ontwikkelaar] wil ik [wat] zodat [waarom]."
31+
2. **Context**: Technische context, gerelateerde issues of code. (optioneel)
32+
3. **Acceptance Criteria**: De concrete done-criteria. (één per regel)
33+
4. **Notities / Open vragen**: Edge cases, twijfels, refinement-punten. (optioneel)
3434

3535
Vraag ook: is dit een **nieuw component**? (bepaalt of de "Bij nieuw component" sectie meegenomen wordt)
3636

3737
---
3838

39-
## Stap 3 Stel de issue body samen
39+
## Stap 3: Stel de issue body samen
4040

4141
Bouw de body op volgens het template hieronder. Vul de gebruikersinput in op de juiste plekken. Laat HTML-commentaren (`<!-- ... -->`) staan als er geen inhoud voor die sectie is.
4242

@@ -95,13 +95,13 @@ Als [gebruiker/ontwikkelaar] wil ik [wat] zodat [waarom].
9595

9696
---
9797

98-
## Stap 4 Toon ter review
98+
## Stap 4: Toon ter review
9999

100100
Laat de volledige title én body zien aan de gebruiker. Vraag om expliciete bevestiging voordat het issue aangemaakt wordt.
101101

102102
---
103103

104-
## Stap 5 Maak het issue aan
104+
## Stap 5: Maak het issue aan
105105

106106
Na bevestiging van de gebruiker:
107107

@@ -115,7 +115,7 @@ Rapporteer de URL van het aangemaakte issue.
115115

116116
## Regels
117117

118-
- Gebruik **altijd** het volledige template sla geen secties over
119-
- Voeg **geen** verzonnen inhoud toe als iets onbekend is, gebruik de HTML-comment placeholder
118+
- Gebruik **altijd** het volledige template: sla geen secties over
119+
- Voeg **geen** verzonnen inhoud toe: als iets onbekend is, gebruik de HTML-comment placeholder
120120
- Vraag altijd om **expliciete bevestiging** voordat het issue aangemaakt wordt
121121
- Sectie `### Bij nieuw component` is **verplicht bij nieuwe componenten**, weglaten bij fixes/chores

.claude/commands/update-docs.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Optionele context die meegegeven kan worden (gebruik $ARGUMENTS als startpunt):
88
99
---
1010

11-
## Stap 1 Begrijp wat er veranderd is
11+
## Stap 1: Begrijp wat er veranderd is
1212

1313
Voer uit:
1414

@@ -29,24 +29,24 @@ Dit bepaalt welke bestanden daadwerkelijk updated moeten worden. Niet elk bestan
2929

3030
---
3131

32-
## Stap 2 Root `README.md`
32+
## Stap 2: Root `README.md`
3333

3434
Controleer en update waar nodig:
3535

36-
- **Componenttelling** tel de werkelijke componenten in de codebase en vergelijk
37-
- **Testaantal** haal het actuele getal op via: `pnpm test run 2>&1 | tail -5`
38-
- **Component tabel** alle componenten vermeld? HTML/CSS + React + Web Component status correct?
39-
- **Scripts sectie** zijn er nieuwe scripts bijgekomen in `package.json`?
40-
- **Tech stack** zijn er versie-wijzigingen (bijv. Storybook, Vitest, TypeScript)?
36+
- **Componenttelling**: tel de werkelijke componenten in de codebase en vergelijk
37+
- **Testaantal**: haal het actuele getal op via: `pnpm test run 2>&1 | tail -5`
38+
- **Component tabel**: alle componenten vermeld? HTML/CSS + React + Web Component status correct?
39+
- **Scripts sectie**: zijn er nieuwe scripts bijgekomen in `package.json`?
40+
- **Tech stack**: zijn er versie-wijzigingen (bijv. Storybook, Vitest, TypeScript)?
4141

4242
---
4343

44-
## Stap 3 `docs/` bestanden
44+
## Stap 3: `docs/` bestanden
4545

4646
### `docs/README.md`
4747

4848
- Componenttelling en statistieken up-to-date?
49-
- Links naar andere docs alle 5 nummers aanwezig?
49+
- Links naar andere docs: alle 5 nummers aanwezig?
5050

5151
### `docs/01-architecture.md`
5252

@@ -90,7 +90,7 @@ Updaten bij: nieuwe addons, nieuwe story-types, gewijzigde Storybook config, nie
9090
Voeg een nieuwe entry toe voor commits die nog niet gedocumenteerd zijn. Formaat:
9191

9292
```markdown
93-
## [versie] YYYY-MM-DD
93+
## [versie]: YYYY-MM-DD
9494

9595
### Added
9696

@@ -113,7 +113,7 @@ Gebruik commit messages en PR-nummers als bron. Sla het over als alle recente co
113113

114114
---
115115

116-
## Stap 4 Storybook `packages/storybook/src/*.docs.md`
116+
## Stap 4: Storybook `packages/storybook/src/*.docs.md`
117117

118118
**Voor elk nieuw component** dat nog geen `.docs.md` heeft:
119119
Maak een nieuw bestand aan in hetzelfde formaat als bestaande bestanden. Kijk naar een bestaand bestand in dezelfde categorie als voorbeeld. Secties:
@@ -132,7 +132,7 @@ Maak een nieuw bestand aan in hetzelfde formaat als bestaande bestanden. Kijk na
132132

133133
---
134134

135-
## Stap 5 Commit
135+
## Stap 5: Commit
136136

137137
Zijn er bestanden gewijzigd? Commit ze dan met een beschrijvend bericht:
138138

@@ -143,15 +143,15 @@ git commit -m "docs: ..."
143143

144144
Gebruik de `docs:` prefix. Noem in de commit message welke versie(s) gedocumenteerd zijn en wat er is toegevoegd of bijgewerkt.
145145

146-
Vraag daarna aan de gebruiker of de commit rechtstreeks naar main gepusht moet worden, of via een PR. Doe dit **niet automatisch** wacht op expliciete bevestiging.
146+
Vraag daarna aan de gebruiker of de commit rechtstreeks naar main gepusht moet worden, of via een PR. Doe dit **niet automatisch**: wacht op expliciete bevestiging.
147147

148148
---
149149

150150
## Regels
151151

152152
- Wijzig **nooit** code-bestanden (`.ts`, `.tsx`, `.css`, `.json` tokens, Storybook stories)
153-
- Wijzig **nooit** `MEMORY.md` of bestanden in `.claude/` dat is Claude's eigen domein
154-
- Voeg **geen** verzonnen statistieken toe haal testaantal en componenttelling altijd uit de werkelijke codebase
153+
- Wijzig **nooit** `MEMORY.md` of bestanden in `.claude/`: dat is Claude's eigen domein
154+
- Voeg **geen** verzonnen statistieken toe: haal testaantal en componenttelling altijd uit de werkelijke codebase
155155
- Houd de **bestaande schrijfstijl** aan: toon, taal (Nederlands of Engels per bestand), opmaak, sectienamen
156-
- Update **alleen wat daadwerkelijk veranderd is** niet elk bestand hoeft bij elke sessie te wijzigen
156+
- Update **alleen wat daadwerkelijk veranderd is**: niet elk bestand hoeft bij elke sessie te wijzigen
157157
- Als iets onduidelijk is: vraag eerst, update daarna

.claude/launch.json

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,10 @@
33
"configurations": [
44
{
55
"name": "storybook",
6-
"runtimeExecutable": "pnpm",
6+
"runtimeExecutable": "/bin/sh",
77
"runtimeArgs": [
8-
"--filter",
9-
"storybook",
10-
"exec",
11-
"storybook",
12-
"dev",
13-
"-p",
14-
"6007"
8+
"-c",
9+
"export PATH=/usr/local/bin:$PATH && pnpm --filter storybook exec storybook dev -p 6007"
1510
],
1611
"port": 6007
1712
}

0 commit comments

Comments
 (0)