vue-dsfr icon indicating copy to clipboard operation
vue-dsfr copied to clipboard

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

Open laruiss opened this issue 2 years ago • 1 comments

Ajouter de la documentation pour :

  • [x] #669
  • [x] DsfrAlert
  • [x] #670
  • [x] DsfrBadge
  • [x] #671
  • [x] DsfrButton
  • [x] DsfrButtonGroup
  • [x] DsfrCallout
  • [x] #695
  • [x] DsfrCheckbox et DsfrCheckboxSet
  • [x] #713
  • [x] DsfrErrorPage
  • [x] #723
  • [x] #725
  • [x] DsfrFileDownloadList
  • [x] DsfrFileUpload
  • [x] DsfrFollow
  • [x] DsfrFooter
  • [x] DsfrFooterLinkList
  • [x] DsfrFooterPartners
  • [x] DsfrFranceConnect
  • [x] DsfrHeader
  • [x] DsfrHeaderMenuLink
  • [x] DsfrHeaderMenuLinks
  • [x] DsfrHighlight
  • [x] DsfrInput
  • [x] DsfrInputGroup
  • [x] DsfrLanguageSelector
  • [x] DsfrLogo
  • [x] DsfrModal
  • [ ] DsfrNavigation
  • [ ] DsfrNavigationItem
  • [ ] DsfrNavigationMegaMenu
  • [ ] DsfrNavigationMegaMenuCategory
  • [ ] DsfrNavigationMenu
  • [ ] DsfrNavigationMenuItem
  • [ ] DsfrNavigationMenuLink
  • [x] DsfrNewsLetter
  • [x] #672
  • [x] DsfrPagination
  • [x] DsfrPicture
  • [x] DsfrQuote
  • [x] DsfrRadioButton et DsfrRadioButtonSet
  • [x] DsfrSearchBar
  • [x] #688
  • [x] DsfrSegmented
  • [x] DsfrSegmentedSet
  • [x] DsfrSelect
  • [x] DsfrShare
  • [ ] DsfrSideMenu (rassembler les enfants ?)
  • [ ] DsfrSideMenuButton
  • [ ] DsfrSideMenuLink
  • [ ] DsfrSideMenuList
  • [ ] DsfrSideMenuListItem
  • [x] DsfrSkipLinks
  • [x] DsfrSocialNetworks
  • [x] DsfrStepper
  • [x] DsfrSummary
  • [x] DsfrTabContent
  • [x] DsfrTabItem
  • [x] DsfrTable (rassembler les enfants ?)
  • [x] DsfrTableCell
  • [x] DsfrTableHeader
  • [x] DsfrTableHeaders
  • [x] DsfrTableRow
  • [x] DsfrTabs
  • [x] DsfrTag
  • [x] DsfrTags
  • [x] DsfrTile et DsfrTiles
  • [x] DsfrToggleSwitch
  • [x] DsfrTooltip
  • [x] DsfrTranscription
  • [x] DsfrVideo

laruiss avatar Dec 07 '23 10:12 laruiss

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 avatar Dec 07 '23 10:12 laruiss