OpenMRS.org project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- OpenMRS.org
- Technical writer:
- Ayeshmantha
- Project name:
- Developing User Friendly GithHub Documentation for REST API
- Project length:
- Standard length (3 months)
Project description
The primary objective of the project is to develop an interactive documentation where end users can interact with API’s with try out options and in the meantime having more descriptive and self explained description which explains the technical and nontechnical people on what situation one should use the endpoint.
The current swagger environment is great but for non techies and techies still it’s harder to get an idea directly without proper documentation. The main idea would be getting this swagger environment and documentation in one place with nice representation. With the help of JS, HTML and CSS.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 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"]]
