Set up typedoc#98
Conversation
|
I also moved some of the doc from the README into the sources, and deleted some that was now useless (it was only describing the types). I also changed how the |
|
Great, thanks! 😄 |
|
Hi, is there something I could help with moving this PR (and the release of the typescripts rewrite) forward? |
|
Sorry, we were drifted away by several other duties, will pick this up soon. |
|
Would love to see this as well! Thanks for making such a huge effort to rewrite everything in TS and keeping this maintained! |
holgerd77
left a comment
There was a problem hiding this comment.
Structurally looks good, there are significant parts of the method descriptions lost though atm.
I think the new doc structure is sufficient, before it was somewhat better structured into these three API components (Wallet, HDKey, Thirdparty) and the methods were somewhat better sorted. Think this is very well worth it though to have this auto-up-to-date now (context for readers: docs were very much outdated on the library here before).
Eventually @ryanio has some idea to get to a better auto-generated structure - since he has worked on similar improvements on other libraries. Not worth the time atm to put too much effort into that though.
|
Closing to resubmit it against the main repo |
This PR sets up typedoc in this project and generates the docs.
PS: @holgerd77, I had to fork the project because I don't have permissions in this repo.