documentatie: API conventies toelichting

[wartburggraaf]

Candidate:

API volgt conventies.

Doel: API volgt conventies en is geprefixed met 'nl'.

🚩 Checkpoint: API conventie

• Toelichting is nodig

• welke namen gebruiken we (anatomie)

• welke manieren gebruiken om waardes toe te kennen (enum, boolean, string)

[Robbert]

Work in progress API conventies in Slack:

https://codefornl.slack.com/docs/T68FXPFQV/F06CFAG6FD1

[Robbert]

In sprint 24 gaan we de API documentatie testen met developers en bespreken in de #nl-design-system-developers chat kanaal om tot een definitieve versie te komen.

Acceptatiecriteria

• Documentatie is getest met developers, getweakt en gereviewed
• Documentatie is gepubliceerd op de NL Design System website als .mdx bestand
• Optioneel: we gebruiken de TaskList of ProgressList component om het stappenplan te tonen.

[Robbert]

Moet ik nog verder reviewen.