Update the documentation

[sami286]

The documentation is updated in code but hasn't been deployed to GH pages for almost 2 years. I've cloned the repo and run npm run doc to verify that the generated documentation includes the latest changes.

EXAMPLE

The current documentation for IBApiNext does not include references to the getMatchingSymbols(...) method (you can try to Ctrl+F for it) but it is included in the actual typedoc code comments.

When regenerating the project docs, this missing method appeared:

ACTIONS

The code itself its ok, the only thing we need to do is to deploy an updated version to GH pages at github.com/stoqey/stoqey.github.io/

[Tsopic]

Can you suggest a working code to deploy it with GH Action automatically on merge to main?

[sami286]

As stated in the post, the code is already working so no working code provision is necesary. The only thing that has to be made, is to deploy the updated documentation to github.com/stoqey/stoqey.github.io/ I've proposed a PR at https://github.com/stoqey/stoqey.github.io/pull/2 Ideally we should integrate the generation and deployment of documentation in the CI so that its done automatically.

[Tsopic]

Thanks for the contribution, I've added you as a collaborator. Feel free to add the gen + CI @sami286

[sami286]

Closing this for now as docs have been updated to reflect latest code comments. The mentioned getMatchingSymbols(...) used as an example now exists:

Will open a new issue/PR for the CI integration whenever I can :)