preloader
  • API Documentation, Technical Writing & Translations
  • Français

Validation API

project image

Lineberty


“Optimize your customer experience and your business by digitalizing queues”

This is my 3rd contract with Lineberty. The missions done in 2019 used Swagger, Hugo and ReDoc.

Les API REST de Lineberty

Project My mission was to document the Validation API: I made the complete review of the Swagger for the reference documentation part and wrote of the user documentation (in English).

The mission also aimed to migrate the user documentation (made with Hugo, see below) to Docusaurus v2, the Lineberty documentation being expected to grow.

The choice fell on Docusaurus v2 for its advanced online documentation framework that uses Markdown files. Its strong points are navigation, search engine, attractive styling options and rather easy customization. Finally, a ReDoc plugin for Docusaurus provides access to Lineberty’s OpenAPIs directly from the single portal for new documentation. A very successful integration!

This migration to Docusaurus v2 was the occasion for a complete review of the documentation, with a new home page and new icons, a new structure and new diagrams.

Mission Keywords Docusaurus, REST API, Swagger, Visual Studio Code, Markdown, Draw.io, ReDoc, GitHub, Sourcetree, anglais.

🔗 The new Lineberty Documentation.