Closed mgramigna closed 1 year ago
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 |
364 tests passing in 28 suites.
Report generated by 🧪jest coverage report action from 84def08cd39dd4f5d2b02c3a9d253e047f41a9d3
~Looks like the link to CONTRIBUTING.md is broken on pages but not locally. Looking into it~
Should be fixed
~The link to the contributing page only works from the website, not the README directly. Looking into it~
Fixed
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
andnpm 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.