Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- OpenMRS.org
- Rédacteur technique:
- Ayeshmantha
- Nom du projet:
- Développer une documentation GithHub conviviale pour l'API REST
- Durée du projet:
- Durée standard (3 mois)
Project description
L'objectif principal de ce projet est de développer une documentation interactive permettant aux utilisateurs finaux d'interagir avec les API à l'aide d'options d'essai. En attendant, il est possible d'avoir une description plus descriptive et plus détaillée pour expliquer aux techniciens et aux non-spécialistes la situation dans laquelle ils doivent utiliser le point de terminaison.
L'environnement swagger actuel est idéal, mais pour les non-techniciens et les technophiles, il est encore plus difficile d'obtenir une idée directement sans documentation appropriée. L'idée principale serait de rassembler cet environnement swagger et cette documentation en un seul endroit avec une bonne représentation. Avec l'aide de JavaScript, HTML et CSS.