Création d'un site pour la documentation / présentation du projet Kontrol

Bonjour !

Nous devons développer un site interne qui servira de plateforme pour présenter et contenir la documentation du projet open source Kontrol. Ce site devra offrir une vue d'ensemble du projet, ainsi que des sections détaillées pour la documentation technique et les guides d'utilisation.

Ce qu'il faut faire :

Développer le site :
- Crée une plateforme web pour héberger et présenter la documentation du projet Kontrol.
- Assure-toi que le site est bien structuré et accessible, avec une navigation claire entre les différentes sections de la documentation.
- Le contributeur a le choix entre le deploiement sur gh-pages ou une autre solution l'hébergement gratuite.
Présenter le projet Kontrol :
- Ajoute une page d'accueil qui donne un aperçu du projet, de ses objectifs, et de ses fonctionnalités principales.
- Inclure des sections pour les différentes parties de la documentation : installation, utilisation, configuration, et contribution.
Intégrer la documentation :
- Crée des pages pour chaque aspect de la documentation technique et des guides d'utilisation. La documentation de l'API est visible a l'aide de postman. (JSON de documentation postman stocké dans docs/api)
Harmoniser le design :
- Assure-toi que le site a un design cohérent avec l'identité visuelle du projet Kontrol.
- Utilise des couleurs, des polices et des styles qui s'alignent avec le branding du projet. (trouvable dans src/assets/fonts)
Optimiser l'expérience utilisateur :
- Veille à ce que le site soit rapide, réactif et facile à naviguer.
- Teste le site sur différents navigateurs et appareils pour garantir une bonne expérience utilisateur.

Ressources utiles

Documentation de Vite (si vous utilisez la techno du frontend du projet)

Informations

Je m'occuperai probablement de cette tâche lorsque j'aurai plus de temps disponible. En attendant, toute contribution ou suggestion est la bienvenue pour préparer le projet.

Niveau de difficulté

Intermédiaire à Avancé - La création d'un site interne complet avec une documentation interactive nécessite une bonne compréhension des outils web et de la gestion de contenu.

Si vous avez des questions ou besoin d’aide, faites-moi signe. 🙌

lalBi94 / kontrol