Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Health Charted Module Template

This is a starter scaffold for authoring a Health Charted module. Fork it, rename, fill in your domain content, publish.

Steps

  1. Fork this repo to your github account
  2. Rename your fork: health-charted-module-<your-domain> (e.g., health-charted-module-fertility)
  3. Edit MODULE.json — replace all placeholder values with your module's metadata
  4. Choose and add a license (replace the LICENSE placeholder)
  5. 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.json with 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 update research/INDEX.json
    • Add reference files to reference/ and update reference/INDEX.json
  6. Update CHANGELOG.md with your initial release entry
  7. Update this README to describe your specific module (replace this content)
  8. Commit, tag (v0.1.0), publish

Resources

  • 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

Local development

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.

About

Starter scaffold for Health Charted modules

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors