chore: publish typedoc generated API docs

[yusefnapora]

This adds a typedoc npm script to the client package to generate API docs and also spruces up the doc comments a bit by adding @link tags and a bit of extra explanation in a few places.

Still needs:

• [x] a "release" action to publish the docs to their final destination when the client package is published

[yusefnapora]

Hmm... not sure why the GH action's aren't running. Will debug this afternoon

[yusefnapora]

current output: https://bafybeigz5ymnlfexdbln7zwuoe4r2awgi4cw6a4fexub3c42bhrjlse2xe.ipfs.nftstorage.link/

[yusefnapora]

@francois-potato are we planning to automate the release process for the client npm package? That seems like a decent place to hook in the typedoc publish action.

If we're not there yet, I can add a script to manually generate the docs and check them into a gh-pages branch, or we could just always publish on merge to main (if files in the client package have changed).

[yusefnapora]

Heads up that I added a typedoc:publish npm script that publishes the typedoc output to github pages. It's now up here: https://web3-storage.github.io/w3name/

I also hooked it into the main client publish script, so it should update the typedocs whenever you publish the npm package (assuming you have write access to the repo).

[joshJarr]

Hey @yusefnapora, nice work! We do want to add the client to the automated release process, but for now we're manually releasing it using the npm run publish command - thanks for adding the typedoc publishing to this!

Happy to grant you permission to the npm package too if you like, do you have a npm user?

Thanks!

[yusefnapora]

Sweet, I'm sefnap on npm.

[yusefnapora]

Yay, I figured out / remembered how to add a status check with a preview link, so now you can click on "Details" in the API docs status check to see the current render.

[joshJarr]

Cool, you should get an invite to collab on the npm package. Ace! Great shout on the preview link - makes it much easier to see and review docs changes, thanks!