docs: initial documentation

[etodanik]

Current Status:
This is still a draft. I'm planning to finish an initial pass documenting most of the actions by EOD Jan 22nd and then move on to adding inline code examples and more detailed usage documentation as a second pass after which I'll switch the PR to a ready for review mode.

Pull request to track typedoc documentation.

Some changes not related to docs for review:

• I added a doc:watch command to be able to do yarn doc:watch and write docs easily
• I am removing I prefixes from interfaces as I encounter them (ICancelBidParams becomes CancelBidParams) because we had a mixed bag and TypeScript mostly discourages prefixed interfaces
• I am adding export to all the nested object parameter interfaces because typedoc doesn't include non-exported interfaces and types by default in the documentation. This is also good because end-users will be able to use those interfaces in their integrations of the JS SDK

[aheckmann]

Is this deprecation correct? I don't see deprecation warnings in MPL or docs yet.

[etodanik]

My bad. I kind of made an assumption here, but realized later on that V2 is still WIP. I'll remove the deprecation notice until V2 is production ready. Should I somehow state V2 to be not ready yet?

[kobyle69]

You have changed 'burnToken' params name and docs, specifically, 'token' to 'account'.

This leads to confusion since docs are pointing out to latest changed done in master branch - https://metaplex-foundation.github.io/js/interfaces/actions.BurnTokenParams.html

However, NPM packages goes only up to v4.12.0 which doesnt contain the changes above.

Sending param as doc states with 'account' will cause an exception.

Many hours lost on this, shouldn't there be a new NPM package with next tag so docs are in full correlation with latest available package via NPM?

@aheckmann

[etodanik]

Yes , this was in the plan but then this was frozen and I didn’t get updates. It should 100% be updated everywhere. Token is an absolutely incorrect name for it. It’s an account. Naming it token can make it seem like you’re expecting a token mint, when in reality you’re to provide the account where this token will be stored.