This is a starter scaffold for authoring a Health Charted module. Fork it, rename, fill in your domain content, publish.
- Fork this repo to your github account
- Rename your fork:
health-charted-module-<your-domain>(e.g.,health-charted-module-fertility) - Edit
MODULE.json— replace all placeholder values with your module's metadata - Choose and add a license (replace the LICENSE placeholder)
- Add your domain content:
- Wiki entities in
wiki/entities/(one entity per markdown file) - Wiki concepts in
wiki/concepts/ - Wiki sources in
wiki/sources/ - Update
wiki/INDEX.jsonwith your entries - Add guides to
guides/(or remove the example guide if you have none) - Add schemas to
schemas/if your module introduces new data types - Add my-data templates to
my-data-templates/if needed - Add research files to
research/raw/and updateresearch/INDEX.json - Add reference files to
reference/and updatereference/INDEX.json
- Wiki entities in
- Update
CHANGELOG.mdwith your initial release entry - Update this README to describe your specific module (replace this content)
- Commit, tag (
v0.1.0), publish
- Module spec:
Family-IT-Guy/health-charted/CONTRIBUTING.md - Module catalog:
Family-IT-Guy/health-charted/guides/module-catalog.md - Health Charted core repo:
Family-IT-Guy/health-charted
Place your module folder directly in a Health Charted instance: <HC-instance>/modules/<your-module>/. Start a session in that instance to test. Iterate by editing files and starting fresh sessions.