search

medic / cht-docs

Documentation site for the Community Health Tookit
https://docs.communityhealthtoolkit.org
14 stars 18 forks source link

Import docs from cht-core #137

Open abbyad opened 4 years ago

abbyad commented 4 years ago

The API docs should be ported over to the doc site.

abbyad commented 4 years ago

Updating issue to review, import and/or update all relevant docs from cht-core.

garethbowen commented 4 years ago

README.md

Much of this should be migrated to the docs site, but we need to have something at the root level. Maybe a brief introduction and then links to the docs?

api/README.md

Move the API documentation to the docs site, and put the migrations and other internal details in code comments.

release-notes/README.md

Leave this where it is - it's just an index of all the different versions. We could consider moving all the release notes to the docs site at some point.

scripts/**/README.md

Leave these where they are.

sentinel/README.md

This is mostly outdated and I think should just be deleted.

shared-libs/search/README.md

This is internal API documentation so should be moved to the code as jsdoc comments.

shared-libs/transitions/src/lib/pupil/README.md

This is the readme of a library that we inlined and then modified, so it's irrelevant. Leave it where it is. One day I hope to replace it with the version in npm...

tests/scalability/README.md

Move this to the docs site. We should consider finding and moving all the testing resources (example) into the new docs site too as QA reference. Maybe this is a separate issue...