GSoD: Developing User Friendly Github Documentation for REST API

Hello :slightly_smiling_face:

I am interested in working on one of your project ideas, namely, Developing User Friendly Github Documentation for REST API.

I have put together a draft proposal for this project, and am hoping to discuss this draft with GSOD mentors. Would this be possible? Burke Mamlin is listed as the mentor for this idea (:wave: Hi Burke, if you’re reading this.) I have the draft up at a public URL, if any OpenMRS mentor would have the time to take a look and give feedback so that I could refine it? Am really hoping to work on this project, so :crossed_fingers:

2 Likes

Hello @ani your welcome to Openmrs and thanks for showing interest in this with a drafted proposal and @burke will respond to you as soon as possible

Hello @gcliff, Thank you for your reply.

My draft proposal is at https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/OpenMRS.md. If the GSoD mentors could do a quick review and let me know whether any info’s missing or inadequate in the proposal, I’d be grateful :slightly_smiling_face:

thanks @ani,

Hello @burke kindly review and guide on this in case of need for corrections and clarifications as the mentor for this project idea.Thanks

1 Like

@ani I will get @burke to look at your proposal. Thank you for your patience

:slightly_smiling_face: Thank you, @c.antwi

@ani, thank you for a very nice proposal. I think one of the most important deliverables for the community is having some friendly documentation on how to approach the API, best practices, and guidance on how to use the various resources. Your proposal could be strengthened by giving a concrete example of how you might approach documentation for a resource – e.g., a Markdown example (or partial example) of documenting Patient, Concept, Obs or any other resource. It’s not required, but it would help me understand both how you would approach the task (not just writing style, but also how you’d approach gathering the details from the wiki, OpenMRS Talk, chats with community members, etc.).

1 Like

@burke, thank you very much for your input. I’ll rework my proposal to include your input.

1 Like