projecttacoma / fqm-execution

fqm-execution is a library that allows users to calculate FHIR-based electronic Clinical Quality Measures (eCQMs) and retrieve the results in a variety of formats
https://projecttacoma.github.io/fqm-execution/
Apache License 2.0
18 stars 6 forks source link

Documentation Overhaul #204

Closed mgramigna closed 1 year ago

mgramigna commented 1 year ago

Summary

This PR completely reworks/rewrites the documentation of the repo. It adds a public site for the docs on gh-pages: https://projecttacoma.github.io/fqm-execution/#/. (NOTE: this is serving this branch right now, when this gets merged I will need to update the pages config to point to master).

Uses docsify to auto-generate the docs page from the README. This ensures that we don't have to maintain an extra site. It will always be in line with the README.

New behavior

None

Code changes

Testing guidance

To set up locally, npm install and npm run docs will serve the docs at localhost:3000. These should match what is deployed to gh pages.

Trying to read the code diff of the README will only lead to madness, don't even bother.

github-actions[bot] commented 1 year ago

Coverage report

St.:grey_question:
Category Percentage Covered / Total
🟢 Statements 85.01% 1990/2341
🟡 Branches 73.68% 1755/2382
🟢 Functions 87.1% 351/403
🟢 Lines 85.3% 1920/2251

Test suite run success

364 tests passing in 28 suites.

Report generated by 🧪jest coverage report action from 84def08cd39dd4f5d2b02c3a9d253e047f41a9d3

mgramigna commented 1 year ago

~Looks like the link to CONTRIBUTING.md is broken on pages but not locally. Looking into it~

Should be fixed

mgramigna commented 1 year ago

~The link to the contributing page only works from the website, not the README directly. Looking into it~

Fixed