Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Heading - Candidate - Documentatie anatomie #216

Open
16 tasks
jeffreylauwers opened this issue Nov 20, 2024 · 0 comments
Open
16 tasks

Heading - Candidate - Documentatie anatomie #216

jeffreylauwers opened this issue Nov 20, 2024 · 0 comments
Labels
community collaboration 🤝 Waar kan de community ons mee helpen documentation documentatie van componenten figma
Milestone

Comments

@jeffreylauwers
Copy link
Contributor

jeffreylauwers commented Nov 20, 2024

Beschrijving

Anatomie van de component is vastgelegd.

Bron: Definition of Done.

Taken

  • Dupliceer de API Alignment FigJam-board (onderdeel van API Alignment).
  • Vul het Figjam-board met voorbeelden van de component, anatomie voorstel opgehaald uit de discussies (onderdeel van API Alignment).
  • Bespreek de anatomie (samen met de overige onderdelen van de API Alignment) met de community en het kernteam (onderdeel van API Alignment).
  • Finaliseer de anatomie (na de API Alignment).
  • Open de Documentatie website afbeeldingen Figma file.
  • Dupliceer een reeds bestaande page.
  • Geef de page de naam van de component.
  • Geef het frame de juiste naam componenten_{naam-van-component}_anatomie.
  • Plaats de component vanuit de 'NLDS Voorbeeld Bibliotheek' op het frame.
  • Gebruik de 'Annotation number' en 'Annotation line' om onderdelen een te wijzen en nummeren. Probeer 48 spacing aan te houden tussen 'Annotation number' en de gehele component.
  • Exporteer het frame als SVG bestand (naam is gelijk aan het frame).
  • @Yolijn hoe gaan we hier verder?
  • Voeg een bestand genaamd _anatomy.md toe binnen de docs folder van de component. Deze folders vind je binnen de docs folder van de Candidate repository in GitHub.
  • Voeg de anatomie documentatie toe aan het bestand. Gebruik hiervoor de volgende opzet:
<!-- @license CC0-1.0 -->

# Anatomie

1. {anatomie-item}
2. {anatomie-item}
3. {anatomie-item}
  • Maak de PR aan gebruik hierbij de volgende opzet:

Commit Message

docs: candidate anatomy for {naam-van-de-component}

Branch

docs/candidate-anatomy-for-{naam-van-de-component}
  • Geef een developer uit het kernteam via Slack een seintje dat deze klaar staat.
@jeffreylauwers jeffreylauwers added this to the Heading milestone Nov 20, 2024
@jeffreylauwers jeffreylauwers added the community collaboration 🤝 Waar kan de community ons mee helpen label Nov 20, 2024
@jeffreylauwers jeffreylauwers changed the title Heading - Candidate - Documentatie anatomy Heading - Candidate - Documentatie anatomie Nov 20, 2024
@jeffreylauwers jeffreylauwers added documentation documentatie van componenten figma labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community collaboration 🤝 Waar kan de community ons mee helpen documentation documentatie van componenten figma
Projects
Status: Todo
Development

No branches or pull requests

1 participant