Documentation: Automated Component Documentation

[Hugos68]

Linked Issue

Closes #2399

Description

Generates JSON documentation files from types.ts files and consumes these in the next.skeleton.dev website.

Additions:

• Added scripts/generate-component-docs.ts file used to generate component docs.
• Added typelens private package for generating documentation from types.ts files.
• Cleaned up some scripts all over the project as many were redundant and/or doing the same thing

Changsets

Instructions: Changesets automate our changelog. If you modify files in /packages, run pnpm changeset in the root of the monorepo, follow the prompts, then commit the markdown file. Changes that add features should be minor while chores and bugfixes should be patch. Please prefix the changeset message with feat:, bugfix: or chore:.

Checklist

Please read and apply all contribution requirements.

• This PR targets the next branch (NEVER master)
• Documentation reflects all relevant changes
• Branch is prefixed with: docs/, feat/, chore/, bugfix/
• Ensure Svelte and Typescript linting is current - run pnpm ci:check
• Ensure Prettier linting is current - run pnpm format
• All test cases are passing - run pnpm test
• Includes a changeset (if relevant; see above)

[changeset-bot]

🦋 Changeset detected

Latest commit: 6167fad

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
skeleton-docs	❌ Failed (Inspect)			Nov 8, 2024 11:19pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
skeleton-themes	⬜️ Ignored (Inspect)	Visit Preview		Nov 8, 2024 11:19pm

[vercel]

@Hugos68 is attempting to deploy a commit to the Skeleton Labs Team on Vercel.

A member of the Team first needs to authorize it.

[Hugos68]

@endigo9740 For the vercel build to pass we need to run pnpm build:docs from the root of the monorepo from now on. The output will be ./sites/next.skeleton.dev/dist relative to the root (in case Vercel requires you to specify).