GalaChain/sdk

Documentation outdated, typedoc fails for chain-ui

Closed this issue · 3 comments

The link for the latest SDK documentation currently redirects to v1.3.0:

https://docs.galachain.com/latest --> https://docs.galachain.com/v1.3.0/

However quite a few newer versions have been published to npm, current latest is 1.4.3:

https://www.npmjs.com/package/@gala-chain/api?activeTab=versions

Attempting to build and serve documentation locally, I see a number of errors caused by the chain-ui package.

e.g.

npm run typedoc-chain-api

The above command outputs a couple hundred lines of error messaging.

It looks like some tsconfig.base.json changes are needed, and/or possibly typedoc needs a vue plugin added.

typedoc_chain-ui_errors.txt

Uploading attachment with terminal output of various chain-ui errors seen when running typedoc.

To replicate, npm install, npm run build from main branch. Then attempt to run any of the npm run typedoc-chain-* commands.

Currently, it's possible to work around this and build/serve the documentation static site locally for development purposes by temporarily deleting the references to chain-ui from tsconfig.base.json in the project root.

We have a lot of documentation to update, it would be nice to get this building again.

This pull request has a basic patch to at least get docs building and serving again:

#376