v3 Docs: Content Updates

[endigo9740]

View the Legacy Ticket

There's still several areas of the documentation that's lacking critical information or needs to be expanded. Since a lot of content inter-links between sections I'll plan to tackle this as a single PR.

If I'm missing anything, feel free to mention it in the comments section below.

Minimum Dependency Versions

See also: #2658

We should keep this as high level as possible to keep it easy to maintain. For example, list "Svelte 5+" instead of a specific numeric version.

Mixing UI Libs Warning

We need an explicit disclaimer regarding mixing multiple Tailwind plugins (ex: Flowbite Svelte). It doesn't come up often, but it can lead to a lot of headache when folks do this.

Rework Introduction

The introduction section is functional, but doesn't really provide a great explanation of what makes Skeleton unique. We should beef this up a bit. Additionally we may need to update the video sooner than later. We should also plan a space for content creator videos.

We should also implement a philosophy section that goes into the details for why Skeleton exists, what makes it unique, and why we choose to implement things the way we do.

Topics to cover may include:

• Why use Tailwind and why we use a Tailwind plugin
• Our preference for native-first, whenever possible
• Why we opt for opt-in strategies (classes, features, etc)
• The benefits of our opinionated component and style props
• ....

Dark Mode Lightswitch

We have a great foundation, but we should help cover how folks can roll their own Lightswitch. We might consider a Cookbook guide for this.

Backgrounds and Theme Extensions

Since v3 Themes no longer include enhancements, we should detail some strategies for how to extend your design in a reusable fashion. This could include a custom CSS file, Tailwind plugin, etc. Additionally, one of the core features of enhancements was background gradients - so we should port over the instructions for both creating and implementing background mesh gradients using theme properties.

Custom Fonts

We currently lack the documentation for implementing custom fonts. Unlike v2, we should aim to use Fontsource in place of Google Fonts to help streamline the process. This can take the form of an Integration Guide.

Color Pairings Expanded

See also: #2845 (comment)

Let's expand the color pairings explanation and examples.

Expand Presets

See also: #3057

The Presets page is functional, but fairly barebones. We should provide more information, examples, and use cases for these features. Additionally, we should show folks how to extend to create their own - we can use "glass" presets as an example. We should also show how presets can be used for Form validation classes

Update Typography

Update the Type Scale example to use a range input or slider component.

Semantic Typography Example

We should consider implementing a opinionated set of canned typographic classes that represent common but project specific classes like display, headline, body sizes, captions, etc. These can be made up of a mix of Skeleton type scale settings, and a mix of Skeleton and Tailwind utility classes. Users will be required to copy/paste these classes into their global CSS so they can edit them directly. They will not be built into our plugin.

Svelte Popover Z-Index

Just like Floating UI we do not take an opinionated stance on z-index and do not set a default value for these components. We should, however, explain how folks can do this.

Cookbook

The Cookbook page is currently a bit easy to miss. We should consider moving it under the the top-level Guides or introducing a new top-level section.

Contribution

The various contribution sections could use a bit of a touch up. Some of the information is out date.

Hide Data Table Integration

This is still coming, but won't arrive until post-release.