[WIP] Adding documentation for @polybase/client

[timmyjose]

Changes:

• added minimal support for TSDoc (typedoc).

Limitations (due to typedoc):

• Only the exported entities appear as is in the documentation. Non-exported types are segregated into an <internal> section per module, but private functions are not listed.
• The layout is flat - the modules all appear in the navigation panel instead of a single entrypoint module, in the documentation.

[linear]

ENG-995 Add documentation for `polybase-ts/client`.

Creating separate issue since polybase-ts has many subprojects, and adding documentation for each project can be better done piecemeal.

[timmyjose]

This is a WIP PR for tracking documentation for @polybase/client. Working on the default HTML documentation first. If desired, Markdown output can be generated using the typedoc-plugin-markdown plugin.

[timmyjose]

How to generate the docs locally:

  $ npm install (or yarn install)

and then

  $ npm run doc (or yarn run doc)

The documentation is generated in a doc directory at the project root. Then we can open it in the browser (for example, on macOS or similar):

  $ open doc/index.html

[timmyjose]

Update: working on a uniform way of updating docs across all projects in polybase-ts conforming to the doc repo's mintlify-based documentation scheme.