Skip to content

Commit 35ab39c

Browse files
committed
docs(Storybook): 📝 met à jour la documentation
1 parent 751d5bd commit 35ab39c

File tree

10 files changed

+53
-2888
lines changed

10 files changed

+53
-2888
lines changed

‎src/composables/useScheme.mdx‎

Lines changed: 0 additions & 122 deletions
This file was deleted.

‎src/stories/docs/01-intro.mdx‎

Lines changed: 13 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -5,105 +5,52 @@ import MailIcon from './mail-fill.svg'
55

66
<Meta title="Docs/1. Introduction" />
77

8-
<div style={{border: 'solid 3px red', fontWeight: 700, padding: '1em', marginBottom: '2rem'}}>
9-
10-
## Cette documentation est obsolète !
8+
# VueDsfr - Introduction
119

1210
Nous vous recommandons de regarder la **nouvelle documentation ici** : [vue-ds.fr](https://vue-ds.fr).
13-
<p>Les stories des composants sont bien à jour (en tout cas pour l’instant), cependant le reste de la documentation n’est plus maintenue ici.</p>
11+
<p>Les stories des composants sont bien Ă  jour.</p>
1412

1513
Si vous recherchez:
1614

17-
* le [storybook](https://stories.vue-ds.fr), le plus à jour est ici : [https://storybook.vue-ds.fr](https://storybook.vue-ds.fr) ;
18-
* l’[application de demo](https://demo.vue-ds.fr) avec plusieurs composants utilisés dans une vraie app Vue 3, c’est ici [https://demo.vue-ds.fr](https://demo.vue-ds.fr) ;
19-
* la [nouvelle documentation](https://vue-ds.fr), c’est ici [https://docs.vue-ds.fr](https://docs.vue-ds.fr) ou plus simplement [https://vue-ds.fr](https://vue-ds.fr) ;
20-
21-
</div>
22-
23-
15+
* la [nouvelle documentation](https://vue-ds.fr), c’est ici [vue-ds.fr](https://vue-ds.fr)
16+
* l’[application de demo](https://demo.vue-ds.fr) avec plusieurs composants utilisés dans une vraie app Vue 3, c’est ici [demo.vue-ds.fr](https://demo.vue-ds.fr) ;
2417

2518

2619
## Qu'est-ce que VueDsfr
2720

2821
VueDsfr est un **portage** du [**Système de design français**](https://www.systeme-de-design.gouv.fr/)
29-
en [**Vue 3**](https://v3.vuejs.org/) sous forme de **bibliothèque de composants**.
22+
en [**Vue 3**](https://vuejs.org/) sous forme de **bibliothèque de composants**.
3023

3124
Le code est [ouvert et disponible sur <img src={GithubIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} /> GitHub](https://github.com/dnum-mi/vue-dsfr)
3225

3326
## Comment débuter
3427

35-
Pour commencer à l’utiliser, [c’est par ici  !](/story/docs-2-guide-d-utilisation--page)
28+
Pour commencer à l’utiliser, [consulter le guide de l’utilisateur](https://vue-ds.fr/guide)
3629

37-
Pour **migrer vers la version 3.x, [c’est par ici  !](/docs/docs-4-migrations--docs)**
30+
Pour commencer Ă  contribuer, [consulter le guide du contributeur](https://vue-ds.fr/guide/guide-developpeur)
3831

3932
## Rejoindre le serveur Discord
4033

41-
Si vous souhaitez participer au projet, poser une question, émettre une critique (ou nous faire des éloges, elles seront bienvenues aussi), nous vous invitons à rejoindre le serveur Discord grâce à ce lien d’invitation :
34+
Si vous souhaitez participer au projet, poser une question, émettre une critique (ou nous faire des éloges, elles seront bienvenues aussi),
35+
nous vous invitons à rejoindre le serveur Discord grâce à ce lien d’invitation :
4236

4337
<div style={{textAlign: 'center'}}>
4438
<a href="https://discord.gg/jbBJ9769ZZ" className="fr-btn">
4539
Rejoindre le serveur Discord
4640
</a>
4741
</div>
4842

49-
## Les acteurs du projet
43+
## Les initiateurs du projet
5044

45+
* **[Stanislas Ormières](https://stormier.ninja)** [<img src={MailIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](mailto:stan@stormier.ninja) [<img src={GithubIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](https://github.com/laruiss) *(Lead dev, architecte, ops, mainteneur principal)*
5146
* **Clément Debroize** [<img src={MailIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](mailto:clement.debroize@interieur.gouv.fr) [<img src={GithubIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](https://github.com/DaBadBunny)
5247
* **Pierre-Louis Egaud** [<img src={MailIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](mailto:pierre-louis.egaud@interieur.gouv.fr) [<img src={GithubIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](https://github.com/plegaud)
53-
* **Stanislas Ormières** [<img src={MailIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](mailto:stan@stormier.ninja) [<img src={GithubIcon} style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} />](https://github.com/laruiss) *(Lead dev, architecte, devops, mainteneur principal)*
5448

5549
Le projet a pu bénéficier des retours et de contributions de
5650

5751
* [Gildéric Deruette](https://github.com/gideruette) ;
5852
* [Sophie Aitis](https://github.com/sophieaitis) ;
59-
* et [Ambroise Maupate](https://github.com/ambroisemaupate)
53+
* [Ambroise Maupate](https://github.com/ambroisemaupate)
54+
* et de **beaucoup d’autres**
6055

6156
Merci Ă  vous !
62-
63-
## Pourquoi VueDsfr
64-
65-
Le Bureau des ressources et réalisations (BRR) a choisi sa stack technique pour le front, et elle inclut
66-
Vue 3. Le Système de design français (DSFR) est développé en JavaScript natif et en SCSS (SASS).
67-
68-
Le BRR a donc besoin d'un portage en Vue 3 de ce DSFR pour ses futurs projets qui devront le respecter.
69-
70-
## VueDsfr en quelques mots
71-
72-
Ce projet de bibliothèque de composants
73-
74-
* reproduit le plus fidèlement possible les composants du [DSFR](https://www.systeme-de-design.gouv.fr/)
75-
* est fait avec [Vue 3](https://vuejs.org)
76-
* est utilisable facilement en tant que plugin Vue 3 ou Nuxt 3
77-
* exporte les types (TypeScript) du plugin, des composants et des composables
78-
* est utilisable facilement dans un projet [npm](https://www.npmjs.com/package/@gouvminint/vue-dsfr)
79-
* met Ă  disposition deux parties dans la documentation :
80-
* une pour [aider au développement](/?path=/story/docs-3-guide-du-développeur--page)
81-
* une autre pour l'[utilisation](/?path=/story/docs-2-guide-d-utilisation--page)
82-
* publie un [site complet](vue-dsfr.netlify.app/) disponible pour tous avec les composants et leurs variants testables dans celui-ci dans un storybook
83-
* a une couverture de test optimale
84-
* met à disposition les composants individuellement sans avoir à importer toute la bibliothèque
85-
(pour les petits projets)
86-
87-
# Les choix techniques retenus
88-
89-
La bibliothèque est faite avec [Vue 3](https://vuejs.org/) et [Vue-router 4](https://router.vuejs.org/).
90-
91-
Le JavaScript est linté avec [ESLint](https://eslint.org/) et formatté selon [StandardJS](https://standardjs.org)
92-
avec une seule modification : les virgules doivent être ajoutées pour tout ce qui est en multiligne
93-
(`"comma-dangle": ["error", "always-multiline"]` cf. [Documentation ESLint](\(https://eslint.org/docs/rules/comma-dangle#options\))).
94-
95-
Le serveur de développement est celui de [Storybook](https://storybook.js.org/), toute la documentation est faite avec
96-
Storybook, et le site pour tester les composants est le storybook lui-mĂŞme.
97-
98-
Le CSS est transpilé avec [LightningCSS](https://lightningcss.dev/) (mais très peu de CSS est propre à la bibliothèque).
99-
100-
Storybook est configuré pour utiliser PostCSS.
101-
102-
Les tests sont faits avec [Vitest](https://vitest.dev) et [Vue Testing Library](https://testing-library.com/docs/vue-testing-library/intro/),
103-
et des tests d’accessibilité sont faits avec [Cypress](https://www.cypress.io/) grâce aux
104-
[tests de composants](https://docs.cypress.io/guides/component-testing/introduction).
105-
106-
Les icônes sont toujours celles de [RemixIcon](https://remixicon.com/), grâce au DSFR et parfois grâce à
107-
[@iconify/vue!](https://iconify.design/docs/icon-components/vue/).
108-
109-
La bibliothèque est mise en paquet grâce à [Vite](https://vitejs.dev/) en [mode bibliothèque](https://vitejs.dev/guide/build.html#library-mode).

0 commit comments

Comments
 (0)