Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up typedoc #98

Closed
wants to merge 4 commits into from
Closed

Set up typedoc #98

wants to merge 4 commits into from

Conversation

alcuadrado
Copy link
Member

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.

@alcuadrado
Copy link
Member Author

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 thirdparty module exports things because typedoc was ignoring it. I believe this change is backwards compatible.

@holgerd77
Copy link
Member

Great, thanks! 😄

@epiccoolguy
Copy link

Hi, is there something I could help with moving this PR (and the release of the typescripts rewrite) forward?

@holgerd77
Copy link
Member

Sorry, we were drifted away by several other duties, will pick this up soon.

@Gameghostify
Copy link

Would love to see this as well! Thanks for making such a huge effort to rewrite everything in TS and keeping this maintained!

Copy link
Member

@holgerd77 holgerd77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@alcuadrado
Copy link
Member Author

Closing to resubmit it against the main repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants