Feature/md typedoc

[dohaki]

This PR includes the API reference for the clientlib which is auto-generated using typedoc from the comments within the source code. The plugin https://github.com/tom-grey/typedoc-plugin-markdown is used to generate the documentation as md files.

As we only want to expose the most important APIs to the user, I tried to find a way to "whitelist" specific methods/classes with typedoc but failed to do so without having to refactor the whole library. So, for now, I added a table of contents file in ./docs/api-reference-index.md where we can refer to the classes that should be part of the documentation. All auto-generated files from typedoc are saved under ./docs/api. If you guys have another suggestion on how to make this better, please let me know.

[codecov-io]

Codecov Report

Merging #304 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #304   +/-   ##
=======================================
  Coverage   62.55%   62.55%           
=======================================
  Files          19       19           
  Lines        1199     1199           
  Branches      226      226           
=======================================
  Hits          750      750           
  Misses        387      387           
  Partials       62       62

Flag	Coverage Δ
#integration	33.19% <ø> (ø)	⬆️
#unit	62.55% <ø> (ø)	⬆️

Impacted Files	Coverage Δ
src/Event.ts	72.6% <ø> (ø)	⬆️
src/User.ts	75.86% <ø> (ø)	⬆️
src/CurrencyNetwork.ts	85% <ø> (ø)	⬆️
src/TLNetwork.ts	81.81% <ø> (ø)	⬆️
src/Trustline.ts	73.04% <ø> (ø)	⬆️
src/Payment.ts	27.41% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 835225e...9fb238f. Read the comment docs.

[weilbith]

What is the state of this PR? Since it is the last one that blocks the big story of trustlines-network/project#798

[ghost]

Do we really want to add the generated markdown files to git?

[weilbith]

Do we really want to add the generated markdown files to git?

I also don't like too much to have sources and generated products in a repo. The problem is that we need that for the centralized dev-docu repo which will fetch the ./doc folder from all relevant projects. Not sure how to solve that better. Maybe we could have a dedicated branch for that (so it does at least no pollute the "main" branches) and let CI generate that. Then could Tatu still refer this repo as sub-module with a specific branch filter.

[dohaki]

Yes definitely is a lot of clutter the auto-generated md files... I like the dedicated branch approach @weilbith mentioned. So shall I clean up the PR by removing the respective files and only leaving the not auto-generated files and changes in?