docs(#9127): document cht-datasource #9192
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jkuester I marked this PR as draft because I just found a bug where the cht-datasource docs will get erased every time cht-docs gets deployed |
m5r
force-pushed
the
9127-document-cht-datasource
branch
from
bf11b75
to
e0b22c8
Compare
|
@sugat009 could you take a look at this PR please? |
sugat009
approved these changes
Jun 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #9127
Generate TypeDoc from the commented source code and push it to medic/cht-datasource to live at https://docs.communityhealthtoolkit.org/cht-datasource.
So once this PR gets merged to master, CI will publish the generated docs every time a PR gets merged to master and a branch build gets published.
Code review checklist
Compose URLs
If Build CI hasn't passed, these may 404:
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.