Proyecto OpenMRS.org
Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la
GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- OpenMRS.org
- Redactor técnico:
- Ayeshmantha
- Nombre del proyecto:
- Cómo desarrollar documentación de GithHub fácil de usar para la API de REST
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
El objetivo principal del proyecto es desarrollar una documentación interactiva en la que los usuarios finales puedan interactuar con las APIs a través de opciones de prueba y, mientras tanto, tener una descripción más descriptiva y autoexplicada que explique a las personas técnicas y no técnicas en qué situación se debería usar el endpoint.
El entorno actual de Swagger es excelente, pero para los no tecnólogos y los tecnólogos, es más difícil obtener una idea directamente sin la documentación adecuada. La idea principal sería obtener este entorno y documentación de swagger en un solo lugar con una buena representación. Con la ayuda de JS, HTML y CSS.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-11-08 (UTC)
[null,null,["Última actualización: 2024-11-08 (UTC)"],[[["The project aims to create user-friendly GitHub documentation for OpenMRS's REST API, making it accessible to both technical and non-technical users."],["It involves developing interactive documentation with \"try-out\" options and clear descriptions of API use cases, enhancing the existing Swagger environment."],["This 3-month Google Season of Docs project will utilize JS, HTML, and CSS to improve the accessibility and understanding of the OpenMRS REST API."]]],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"]]
