[roschreiber]

This draft replaces the current, hand-written Github Pages site (on the gh-pages branch) with API docs generated by TypeDoc straight from the source and README.

This makes the docs much easier to maintain. The API reference is built from comments in the code, so changes no longer have to be copied into the docs by hand. The pages will be rebuilt with every push to the master branch.

{Preview

A live preview of the new site is available on my fork: https://roschreiber.github.io/tedious/

Generating docs locally

npm run docs

Then open docs/index.html.

What's left to do

• A lot of the API still has no doc comments, so those parts are just empty now, and adding them is the main thing that's still left to do.
• Additionally, a version switcher for the TypeDocs so the docs of older major versions stay available, like on the current site would be a nice thing to implement
• Once all of the above are done, the repo's pages source needs to be switched to "Github Actions" so that the new site replaced the old one

@arthurschreiber

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.37%. Comparing base (3c98797) to head (4995220).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1815   +/-   ##
=======================================
  Coverage   83.37%   83.37%           
=======================================
  Files          95       95           
  Lines        4709     4709           
  Branches      881      881           
=======================================
  Hits         3926     3926           
  Misses        529      529           
  Partials      254      254           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.