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.

Sign up for GitHub

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

Jump to bottom

Ajouter de la documentation Vitepress pour tous les composants (Epic) #668

Open
50 of 73 tasks
laruiss opened this issue Dec 7, 2023 · 1 comment
Open
50 of 73 tasks

Ajouter de la documentation Vitepress pour tous les composants (Epic) #668

laruiss opened this issue Dec 7, 2023 · 1 comment
Assignees
@laruiss
Labels
documentation Ajout ou modification de la documentation

Comments

@laruiss
Copy link
Collaborator

laruiss commented Dec 7, 2023 •
edited
Loading

Ajouter de la documentation pour :
@laruiss
Copy link
Collaborator Author

laruiss commented Dec 7, 2023 •
edited
Loading

Pour chacun, voici (un brouillon de) la DoD :

  • reprise du début de la documentation officielle qui présente le composant en rajoutant les liens avec les props
  • lien vers le storybook
  • lien vers la doc officielle DSFR du composant
  • récapitulatif des props dans un tableau (nom, type, défaut, obligatoire, description)
  • récapitulatif des événements dans un tableau (nom, type de payload si présent)
  • récapitulatif des slots
  • exemples
  • ajouter un lien dans la sidebar (.vitepress/config.ts, dans themeConfig.sidebar)
  • ajouter un lien dans docs/composants.md

Parfois, ce serait bien de rajouter :

  • astuces (optionnel)

S’inspirer de DsfrAlert

N.B. : Convertir chaque bullet point en issue et s’assigner dessus

@laruiss laruiss self-assigned this Dec 22, 2023
@laruiss laruiss added the documentation Ajout ou modification de la documentation label Dec 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@laruiss laruiss

Labels
documentation Ajout ou modification de la documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@laruiss