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

Créer une page recensant tous les components #29

Closed
clodiap opened this issue Oct 21, 2020 · 1 comment · Fixed by #52
Closed

Créer une page recensant tous les components #29

clodiap opened this issue Oct 21, 2020 · 1 comment · Fixed by #52
Assignees
Labels
🙋 besoin d'aide Issue en cours d'écriture, nécessite de l'aide documentation Améliorer la documentation du repo

Comments

@clodiap
Copy link
Collaborator

clodiap commented Oct 21, 2020

Résumé de l'issue

Créer une page de documentation recensant les components utilisés dans l'application et expliquant leur fonctionnement.

Situation actuelle

Pour l'instant nous n'avons pas de documentation sur les components.

Solution voulue

Il faudrait créer une page components.md (à la racine du projet ?), qui recense tous les components déjà créés, expliquer comment les utiliser (import du fichier, utilisation des variables, …), et expliquer comment en créer un nouveau.
Rajouter une petite explication sur les modules css : https://v2.docusaurus.io/docs/styling-layout#css-modules

@clodiap clodiap added documentation Améliorer la documentation du repo 🙋 besoin d'aide Issue en cours d'écriture, nécessite de l'aide labels Oct 21, 2020
@clodiap
Copy link
Collaborator Author

clodiap commented Oct 28, 2020

Du coup je me demandais pour cette issue si on créait pas un dossier documentation à la racine et on pourrait y ranger les éventuels autres fichiers relatifs à la documentation ?

@clodiap clodiap self-assigned this Oct 28, 2020
@AJuliette AJuliette linked a pull request Nov 15, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🙋 besoin d'aide Issue en cours d'écriture, nécessite de l'aide documentation Améliorer la documentation du repo
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants