docs: generate API reference docs from TS packages

[pkosiec]

https://databricks.atlassian.net/browse/LKB-7605

API reference docs are generated on pnpm docs:dev or pnpm docs:build.

Demo

docs.mp4

[pkosiec]

Renamed App Kit to AppKit:

[MarioCadenas]

are all these auto generated?

[MarioCadenas]

After checking the docs, not so much the code, I find this a bit confusing:

• Some things are documented that probably should not be shown in the docs like the CacheManager
• The "Variables" section is a bit confusing, not sure if we need that
• in @databricks/appkit-ui all the components are under Functions, maybe we should have a components section, and review how we are actually showing the usage of them?

I imagine there are other PRs to come so we complete the documentation, but I'm not sure what's the purpose of this one, I'm probably missing the step in between this PR and the last version

We can discuss this when you are back @pkosiec

[pkosiec]

Thanks @MarioCadenas for your input.

This PR is a baseground for having a proper API reference doc. Unfortunately we're quite behind with the code documentation. We should be cautious what we export (and whether the stuff is internal or external). I didn't want to do more comments modifications as this PR with generated changes is too huge already but your comment is totally valid so I'll push some of them already 👍

appkit

Some things are documented that probably should not be shown in the docs like the CacheManager

Makes sense, I'll mark it as an @internal 👍 Or we could consider unexporting it altogether. Currently it is exported because I used it in the telemetry example but it is not a must have, honestly.

The "Variables" section is a bit confusing, not sure if we need that

Agree, made most of the items internal, renamed Variables to Helpers and kept the sql helper only.

This is how it looks like now after changes:

Not sure what to do with the functions? Should we mark most of them as internal as well?

appkit-ui

You're right, I tried to customize the component docs generation with the the solution we have in place, but sadly, it is very limited 😞 Let me check the other options 👍