“Optimisez l’expérience de vos clients et votre activité en supprimant les files d’attente !”
Il s’agit de ma 3ème mission pour Lineberty.
Projet J’ai eu pour mission de documenter l’API de Validation : revue complète du Swagger pour la partie documentation de référence et rédaction de la documentation utilisateur (en anglais).
La mission a aussi eu pour but de migrer la documentation utilisateur (faite avec Hugo, voir ci-dessous) vers Docusaurus v2, la documentation de Lineberty étant appelée à grossir.
Le choix s’est porté vers Docusaurus v2 pour son framework avancé de documentation en ligne qui utilise des fichiers Markdown. Ses points forts sont la navigation, le moteur de recherche, des options de style séduisantes et une personnalisation plutôt facile. Enfin, un plugin ReDoc pour Docusaurus permet d’accéder aux OpenAPIs de Lineberty directement depuis le portail unique de la nouvelle documentation. Une intégration très réussie !
Cette migration vers Docusaurus v2 a été l’occasion d’une revue complète de la documentation, avec une nouvelle page d’accueil et de nouvelles icônes, une nouvelle structure et de nouveaux schémas.
Mots clés de la mission Docusaurus, REST API, Swagger, Visual Studio Code, Markdown, Draw.io, ReDoc, GitHub, Sourcetree, anglais.