Developer Documentation for Third-Party Plugins in Open Mobile Hub (OMH) #3
Description
Issue
As we prepare to release the Open Mobile Hub (OMH) to the open-source community, we require developer documentation for third-party implementation/plugin developers. This documentation will include a usage guide that explains which classes, interfaces, config files, etc. a third-party plugin developer provider needs to implement to incorporate support for their services in OMH. Along with this documentation, we expect Javadocs for classes, interfaces, enums, etc. with reference documentation generated from the source code comments and annotation.
Desired Outcome
We need the developer documentation for third-party implementation/plugin developers to be created and uploaded to the GitHub Wiki for OMH. The document should be polished and organized, providing clear instructions and examples for third-party plugin developers. This documentation is different from the developer guide to use the plugin/implementations that we already have drafts for.
Tasks
- Create a detailed developer documentation for third-party implementation/plugin developers to use OMH.
- Include a usage guide explaining which classes, interfaces, config files, etc. a third-party plugin developer provider needs to implement to incorporate support for their services in OMH.
- Include Javadocs for classes, interfaces, enums, etc. with reference documentation generated from the source code comments and annotation.
- Upload the documentation to GitHub Wiki.
- Ensure the document is polished and organized.
Additional Information
Examples of services that providers would build plugins for in the future are OMH Auth, OMH Maps, OMH Cloud storage, and backup.
Please let us know if you have any questions or concerns.
CC - @rquino @prestonlau