...
| Info |
|---|
This idea list is not final yet. More projects could be added or removed. |
Automated Maintenance of Mifos X
...
API Documentation
| Mentors | johnwoodlock (Unlicensed) | ||
| Overview & Objectives | |||
| Description | |||
| Impact | Worldwide, there are multitudes of methodologies and delivery channels in which to deliver financial services to the poor. On the platform through the API, our community has the ability to build applications to allow Mifos to support new markets and scale more services to the poor in need. Our community is global and of varying skillsets, so it's critical that the API is well-documented and constantly up to date with clear examples.This project | will significantly reduce the burden of maintaining this documentation.||
| Other Resources |
...
focuses on simplifying/automating the maintenance of the Mifos X API documentation (https://demo.openmf.org/api-docs/apiLive.htm) and ensuring it is complete:
| |
| Description | The API is probably the most important part of the new Mifos X platform and that's why we put a ton of effort into making it easier for developers to see examples and interact with. It's certainly not 'passive' documentation and must be interactive and up to date such that our community can see the flexibility and power in which the API can be used to support new financial services or support alternative way for accessing the Mifos technology. However, its currently a manual process that is a bit of a pain to complete and because of that our current documentation can become out of date. |
| Helpful Skills | |
| Impact | Worldwide, there are multitudes of methodologies and delivery channels in which to deliver financial services to the poor. On the platform through the API, our community has the ability to build applications to allow Mifos to support new markets and scale more services to the poor in need. Our community is global and of varying skillsets, so it's critical that the API is well-documented and constantly up to date with clear examples. This project will significantly reduce the burden of maintaining this documentation. |
| Other Resources |
This project focuses on simplifying/automating the maintenance of the Mifos X API documentation (https://demo.openmf.org/api-docs/apiLive.htm) and ensuring it is complete:
- Ensure that all REST services are included and to the standard required in the documentation.
- Automate maintenance of documentation so it must be in sync with code base and can 'alarm' us if not complete.
So, I'm seeing a project that would look at automating it so it has to be in sync with the code base and maybe 'alarm' if not complete.
...