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

Update Docusaurus 3 and other npm packages #282

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

afomi
Copy link
Contributor

@afomi afomi commented Feb 12, 2025

this branch includes some manual updates to markdown files, where certain TypeScript documentation syntax couldn't be parsed.

I addressed most of these by wrapping code in a ts code block. A dozen or so others, I tried wrapping in code syntax.

It looks like the docs may have been generated using typedoc, and if so, it'd be worthwhile to regenerate the scrypt-ts documentation.


Update:

I ended up adding typedoc to this branch and can generate the latest scrypt-ts docs using npx typedoc.

There appears to be a change with the BSV library, such that the latest version of scrypt-ts is now using @scrypt-inc/bsv. These files were generated, but I removed them for now.

They can be regenerated easily by running npx typedoc again.

I did notice that the docs showed more README files in the docs, which looked a little odd, which is why I ended up deleting them for now.

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.

1 participant