Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Test Harness documentation #157

Open
billwambua opened this issue Mar 7, 2022 · 1 comment
Open

Improve Test Harness documentation #157

billwambua opened this issue Mar 7, 2022 · 1 comment
Assignees

Comments

@billwambua
Copy link
Member

The documentation for the Test Harness is too terse and is hard to follow at times. It also needs a larger variety of examples especially for people just getting into using it.

Right now the best and fastest way to learn how to use it is to check people who have used it before.

The documentation for the Test Harness is generated from the incode comments using Doxygen I believe.

Solution for this is to add more elaborate in code documentation.

@billwambua billwambua self-assigned this Mar 7, 2022
@kennsippell
Copy link
Member

Agreed. Check out https://github.com/medic/app-services-team/issues/32 and the resulting Capacity Building Guide written by @binokaryg . Tons of good content there and I believe he is working on getting that into standard public formats and integrated with https://docs.communityhealthtoolkit.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants