Improve SDK refs

[0div]

Description

• Version dropdown in TOC
• Improve js-sdk api ref with typedoc markdown options
• Levarage auto anchor link generation with h2 and h3s for cli sdk
• CSS styling

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8dbfe63

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[mishushakov]

I just took a quick look at the Vercel preview of curiosity:

• Don't see a dropdown anywhere?
• For JS, can you remove "Defined in", it isn't particularly useful?
• Can you make methods either bold or ### (h3) in markdown?
• Parameters look different in javascript docs (table) and python (list)

[mlejva]

I just took a quick look at the Vercel preview of curiosity:

• Don't see a dropdown anywhere?
• For JS, can you remove "Defined in", it isn't particularly useful?
• Can you make methods either bold or ### (h3) in markdown?
• Parameters look different in javascript docs (table) and python (list)

We discussed it in person and made some compromises mostly around unifying styling and information. The problem is we would need to write our own docstrings parser as the current ones are sufficient for us.

• Don't see a dropdown anywhere?

Version dropdown? We haven't figured out where to put it yet.
EDIT: We have a good idea now.

• Can you make methods either bold or ### (h3) in markdown?

This one is the main thing we need to figure out if we can do.

• Parameters look different in javascript docs (table) and python (list)

Here we compromised and it will be different

[mishushakov]

Will you also be adding Pty and Commands types to JS ref?

[0div]

Will you also be adding Pty and Commands types to JS ref?

good catch @mishushakov , I have included them by fixing the typedoc config

[mlejva]

Todo list before we can merge release (I'm working on both)

• move the top bar navigation "Documentation", "SDK Reference", "Dashboard" to the navbar
• Fix the navbar item selection not staying selected when you open a page