Skip to content

Commit aa600a4

Browse files
endigo9740endigo9740
authored
v3 Docs - Prepare for Launch (#3356)
1 parent 7657a8d commit aa600a4

File tree

10 files changed

+59
-183
lines changed

10 files changed

+59
-183
lines changed

‎sites/next.skeleton.dev/src/content/docs/get-started/core-api.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Extends Tailwind's base layer with a set of opinionated global styles.
2828
<figure class="linker bg-noise">
2929
<a
3030
class="btn preset-filled"
31-
href="https://github.com/skeletonlabs/skeleton/blob/next/packages/skeleton/src/base/globals.css"
31+
href="https://github.com/skeletonlabs/skeleton/blob/main/packages/skeleton/src/base/globals.css"
3232
target="_blank"
3333
>
3434
View Global Styles
@@ -48,7 +48,7 @@ Uses Tailwind's `@theme` to implement a variety of new properties and utility cl
4848
<figure class="linker bg-noise">
4949
<a
5050
class="btn preset-filled"
51-
href="https://github.com/skeletonlabs/skeleton/blob/next/packages/skeleton/src/base/theme.scss"
51+
href="https://github.com/skeletonlabs/skeleton/blob/main/packages/skeleton/src/base/theme.scss"
5252
target="_blank"
5353
>
5454
View Theme Properties
@@ -162,7 +162,7 @@ Sets the default width for border, divide, and ring width to match the active th
162162
## @utility
163163

164164
<figure class="linker bg-noise">
165-
<a href="https://github.com/skeletonlabs/skeleton/blob/next/packages/skeleton/src/utilities" target="_blank" class="btn preset-filled">
165+
<a href="https://github.com/skeletonlabs/skeleton/blob/main/packages/skeleton/src/utilities" target="_blank" class="btn preset-filled">
166166
View Utilites
167167
</a>
168168
</figure>
@@ -176,7 +176,7 @@ Allow you to style semantic HTML elements with utility classes.
176176
## @variant
177177

178178
<figure class="linker bg-noise">
179-
<a href="https://github.com/skeletonlabs/skeleton/blob/next/packages/skeleton/src/variants" target="_blank" class="btn preset-filled">
179+
<a href="https://github.com/skeletonlabs/skeleton/blob/main/packages/skeleton/src/variants" target="_blank" class="btn preset-filled">
180180
View Variants
181181
</a>
182182
</figure>

‎sites/next.skeleton.dev/src/content/docs/get-started/installation/astro.mdx‎

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,15 @@ import ProcessStep from '@components/docs/ProcessStep.astro';
1414

1515
## Requirements
1616

17-
| Tooling | Minimum Version |
18-
| ------------------------------------ | --------------- |
19-
| [Astro](https://vite.dev/) | 5 |
20-
| [React](https://react.dev/) | 18 |
21-
| [Svelte](https://svelte.dev/) | 5 |
22-
| [Tailwind](https://tailwindcss.com/) | 4 |
17+
| Tooling | Supported Versions |
18+
| ------------------------------------ | ------------------ |
19+
| [Astro](https://vite.dev/) | 5 |
20+
| [React](https://react.dev/) | 18 |
21+
| [Svelte](https://svelte.dev/) | 5 |
22+
| [Tailwind](https://tailwindcss.com/) | 4 |
2323

2424
## Installation
2525

26-
{
27-
28-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
29-
<p>
30-
WARNING: The following guide will install a pre-release version of Skeleton v3. Some features may be missing, incomplete, or
31-
non-functional at this time. Please report bugs and issues on{' '}
32-
<a className="anchor" href="https://github.com/skeletonlabs/skeleton/issues/new/choose" target="_blank" rel="external">
33-
GitHub
34-
</a>{' '}
35-
or{' '}
36-
<a className="anchor" href="https://discord.gg/EXqV7W8MtY" target="_blank" rel="external">
37-
Discord
38-
</a>
39-
.
40-
</p>
41-
</div>
42-
43-
}
44-
4526
Learn how to install the Skeleton core into your Astro project. We'll cover using components in the section below.
4627

4728
<Process>

‎sites/next.skeleton.dev/src/content/docs/get-started/installation/nextjs.mdx‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,14 @@ import ProcessStep from '@components/docs/ProcessStep.astro';
1414

1515
## Requirements
1616

17-
| Tooling | Minimum Version |
18-
| ------------------------------------ | --------------- |
19-
| [Next.js](https://nextjs.org/) | 15 |
20-
| [React](https://react.dev/) | 18 |
21-
| [Tailwind](https://tailwindcss.com/) | 4 |
17+
| Tooling | Supported Versions |
18+
| ------------------------------------ | ------------------ |
19+
| [Next.js](https://nextjs.org/) | 15 |
20+
| [React](https://react.dev/) | 18 |
21+
| [Tailwind](https://tailwindcss.com/) | 4 |
2222

2323
## Installation
2424

25-
{
26-
27-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
28-
<p>
29-
WARNING: The following guide will install a pre-release version of Skeleton v3. Some features may be missing, incomplete, or
30-
non-functional at this time. Please report bugs and issues on{' '}
31-
<a className="anchor" href="https://github.com/skeletonlabs/skeleton/issues/new/choose" target="_blank" rel="external">
32-
GitHub
33-
</a>{' '}
34-
or{' '}
35-
<a className="anchor" href="https://discord.gg/EXqV7W8MtY" target="_blank" rel="external">
36-
Discord
37-
</a>
38-
.
39-
</p>
40-
</div>
41-
42-
}
43-
4425
<Process>
4526
<ProcessStep step="1">
4627
### Create a Project

‎sites/next.skeleton.dev/src/content/docs/get-started/installation/other.mdx‎

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: '@layouts/LayoutDoc.astro'
3-
title: Other
4-
description: Generic guidance for installing Skeleton for other frameworks.
3+
title: Other Frameworks
4+
description: Install Skeleton for other frameworks.
55
order: 1000
66
---
77

@@ -16,7 +16,7 @@ import ProcessStep from '@components/docs/ProcessStep.astro';
1616

1717
Skeleton's [Core Package](/docs/get-started/core-api) is framework agnostic, meaning many of the Design System and Tailwind-centric features can used on any number of frameworks. This includes everything _except_ components. In order to install Skeleton for additional framework, your app must be able to support the following:
1818

19-
| Tooling | Minimum Version |
19+
| Tooling | Supported Versions |
2020
| ------------------------------------ | --------------------- |
2121
| Package Management | NPM, PNPM, Yarn, etc. |
2222
| [Tailwind](https://tailwindcss.com/) | 4 |
@@ -25,25 +25,6 @@ The exact instructions for installing Skeleton will differ per framework, howeve
2525

2626
## Installation
2727

28-
{
29-
30-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
31-
<p>
32-
WARNING: The following guide will install a pre-release version of Skeleton v3. Some features may be missing, incomplete, or
33-
non-functional at this time. Please report bugs and issues on{' '}
34-
<a className="anchor" href="https://github.com/skeletonlabs/skeleton/issues/new/choose" target="_blank" rel="external">
35-
GitHub
36-
</a>{' '}
37-
or{' '}
38-
<a className="anchor" href="https://discord.gg/EXqV7W8MtY" target="_blank" rel="external">
39-
Discord
40-
</a>
41-
.
42-
</p>
43-
</div>
44-
45-
}
46-
4728
<Process>
4829
<ProcessStep step="1">
4930
### Create a Project

‎sites/next.skeleton.dev/src/content/docs/get-started/installation/sveltekit.mdx‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,14 @@ import ProcessStep from '@components/docs/ProcessStep.astro';
1414

1515
## Requirements
1616

17-
| Tooling | Minimum Version |
18-
| ------------------------------------ | --------------- |
19-
| [SvelteKit](https://svelte.dev/) | 2 |
20-
| [Svelte](https://svelte.dev/) | 5 |
21-
| [Tailwind](https://tailwindcss.com/) | 4 |
17+
| Tooling | Supported Versions |
18+
| ------------------------------------ | ------------------ |
19+
| [SvelteKit](https://svelte.dev/) | 2 |
20+
| [Svelte](https://svelte.dev/) | 5 |
21+
| [Tailwind](https://tailwindcss.com/) | 4 |
2222

2323
## Installation
2424

25-
{
26-
27-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
28-
<p>
29-
WARNING: The following guide will install a pre-release version of Skeleton v3. Some features may be missing, incomplete, or
30-
non-functional at this time. Please report bugs and issues on{' '}
31-
<a className="anchor" href="https://github.com/skeletonlabs/skeleton/issues/new/choose" target="_blank" rel="external">
32-
GitHub
33-
</a>{' '}
34-
or{' '}
35-
<a className="anchor" href="https://discord.gg/EXqV7W8MtY" target="_blank" rel="external">
36-
Discord
37-
</a>
38-
.
39-
</p>
40-
</div>
41-
42-
}
43-
4425
<Process>
4526
<ProcessStep step="1">
4627
### Create a Project

‎sites/next.skeleton.dev/src/content/docs/get-started/installation/vite-react.mdx‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,14 @@ import ProcessStep from '@components/docs/ProcessStep.astro';
1414

1515
## Requirements
1616

17-
| Tooling | Minimum Version |
18-
| ------------------------------------ | --------------- |
19-
| [Vite](https://vite.dev/) | 6 |
20-
| [React](https://react.dev/) | 18 |
21-
| [Tailwind](https://tailwindcss.com/) | 4 |
17+
| Tooling | Supported Versions |
18+
| ------------------------------------ | ------------------ |
19+
| [Vite](https://vite.dev/) | 6 |
20+
| [React](https://react.dev/) | 18 |
21+
| [Tailwind](https://tailwindcss.com/) | 4 |
2222

2323
## Installation
2424

25-
{
26-
27-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
28-
<p>
29-
WARNING: The following guide will install a pre-release version of Skeleton v3. Some features may be missing, incomplete, or
30-
non-functional at this time. Please report bugs and issues on{' '}
31-
<a className="anchor" href="https://github.com/skeletonlabs/skeleton/issues/new/choose" target="_blank" rel="external">
32-
GitHub
33-
</a>{' '}
34-
or{' '}
35-
<a className="anchor" href="https://discord.gg/EXqV7W8MtY" target="_blank" rel="external">
36-
Discord
37-
</a>
38-
.
39-
</p>
40-
</div>
41-
42-
}
43-
4425
<Process>
4526
<ProcessStep step="1">
4627
### Create a Project

‎sites/next.skeleton.dev/src/content/docs/get-started/installation/vite-svelte.mdx‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,14 @@ import ProcessStep from '@components/docs/ProcessStep.astro';
1414

1515
## Requirements
1616

17-
| Tooling | Minimum Version |
18-
| ------------------------------------ | --------------- |
19-
| [Vite](https://vite.dev/) | 6 |
20-
| [Svelte](https://svelte.dev/) | 5 |
21-
| [Tailwind](https://tailwindcss.com/) | 4 |
17+
| Tooling | Supported Versions |
18+
| ------------------------------------ | ------------------ |
19+
| [Vite](https://vite.dev/) | 6 |
20+
| [Svelte](https://svelte.dev/) | 5 |
21+
| [Tailwind](https://tailwindcss.com/) | 4 |
2222

2323
## Installation
2424

25-
{
26-
27-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
28-
<p>
29-
WARNING: The following guide will install a pre-release version of Skeleton v3. Some features may be missing, incomplete, or
30-
non-functional at this time. Please report bugs and issues on{' '}
31-
<a className="anchor" href="https://github.com/skeletonlabs/skeleton/issues/new/choose" target="_blank" rel="external">
32-
GitHub
33-
</a>{' '}
34-
or{' '}
35-
<a className="anchor" href="https://discord.gg/EXqV7W8MtY" target="_blank" rel="external">
36-
Discord
37-
</a>
38-
.
39-
</p>
40-
</div>
41-
42-
}
43-
4425
<Process>
4526
<ProcessStep step="1">
4627
### Create a Project

‎sites/next.skeleton.dev/src/content/docs/get-started/migrate-from-v2.mdx‎

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@ order: 9999
99
export const components = componentSet;
1010
import NavGrid from '@components/docs/NavGrid.astro';
1111

12-
{
13-
14-
<div className="card preset-outlined-error-500 preset-tonal-error p-8 space-y-8">
15-
<p>
16-
WARNING: Skeleton v3 is currently in a pre-release status. It is not yet intended for production use. This may include bugs, incomplete
17-
documentation, and breaking changes leading up to the full release. Depending on the scale and scope of of your project, we may even
18-
encourage of your application to take full advantage of all changes.
19-
</p>
20-
</div>
21-
22-
}
23-
2412
## Introduction
2513

2614
Version 3 represents a major overhaul to Skeleton. This includes a ground up rewrite of quite literally every feature in the library. We have provided a migration CLI to help automate this process. However, some portions of this migration will still required manual intervention. This is not a trivial migration from prior versions, so please use caution when updating and ensure you follow this guide very carefully.
@@ -53,11 +41,23 @@ Skeleton is built on top of the following technologies. These must be migrated i
5341

5442
### Svelte v5
5543

56-
Migrate to the latest release of Svelte v5 ([migration guide](https://svelte.dev/docs/svelte/v5-migration-guide))
44+
Migrate to the latest release of Svelte v5.
45+
46+
<figure class="linker bg-noise">
47+
<a class="btn preset-filled" href="https://svelte.dev/docs/svelte/v5-migration-guide" target="_blank">
48+
Svelte v5 Migration &rarr;
49+
</a>
50+
</figure>
5751

5852
### SvelteKit v2
5953

60-
Migrate to the latest release of SvelteKit v2 ([migration guide](https://svelte.dev/docs/kit/migrating-to-sveltekit-2))
54+
Migrate to the latest release of SvelteKit v2.
55+
56+
<figure class="linker bg-noise">
57+
<a class="btn preset-filled" href="https://svelte.dev/docs/kit/migrating-to-sveltekit-2" target="_blank">
58+
SvelteKit v2 Migration &rarr;
59+
</a>
60+
</figure>
6161

6262
### Tailwind v4
6363

@@ -67,7 +67,13 @@ Before migration to tailwind V4 using their upgrade guide some manual steps are
6767
2. Rename your `app.postcss` or `app.pcss` to `app.css`.
6868
3. Remove the `purgecss` (`vite-plugin-tailwind-purgecss`) vite plugin from your `vite.config` (if installed).
6969

70-
Migrate to the latest release of Tailwind v4 ([migration guide](https://tailwindcss.com/docs/upgrade-guide))
70+
Migrate to the latest release of Tailwind v4.
71+
72+
<figure class="linker bg-noise">
73+
<a class="btn preset-filled" href="https://tailwindcss.com/docs/upgrade-guide" target="_blank">
74+
Tailwind v4 Migration &rarr;
75+
</a>
76+
</figure>
7177

7278
---
7379

@@ -119,17 +125,6 @@ What will NOT be migrated...
119125

120126
Make sure to consult your local Git Diff to compare what has been modified before progressing forward or committing these automated changes.
121127

122-
{
123-
124-
<div class="card preset-outlined-warning-500 preset-tonal-warning p-8 space-y-8">
125-
<p>
126-
Early Adopters: In extremely rare instances the CLI may modify values outside the scope of Skeleton. If this occurs, please report this
127-
as a bug in the <code className="code">#skeleton-cli-beta</code> channel on Discord!
128-
</p>
129-
</div>
130-
131-
}
132-
133128
---
134129

135130
## Additional Migration

‎sites/next.skeleton.dev/src/layouts/LayoutDoc.astro‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,11 @@ const layoutProps = {
4747
classList: 'grid grid-rows-[auto_1fr]'
4848
};
4949
// GitHub Settings
50-
const branch = 'next';
51-
// @ts-expect-error - FIXME: update before launch
52-
const docSite = branch === 'master' ? 'skeleton.dev' : 'next.skeleton.dev';
50+
const branch = 'main';
51+
const site = 'skeleton.dev';
5352
// URLs
5453
const urls = {
55-
githubDocsUrl: `https://github.com/skeletonlabs/skeleton/tree/${branch}/sites/${docSite}/src/content`,
54+
githubDocsUrl: `https://github.com/skeletonlabs/skeleton/tree/${branch}/sites/${site}/src/content`,
5655
githubSkeletonUrl: `https://github.com/skeletonlabs/skeleton/tree/${branch}/packages/skeleton/src`,
5756
githubSvelteUrl: `https://github.com/skeletonlabs/skeleton/tree/${branch}/packages/skeleton-svelte`,
5857
githubReactUrl: `https://github.com/skeletonlabs/skeleton/tree/${branch}/packages/skeleton-react`

‎sites/next.skeleton.dev/src/layouts/LayoutRoot.astro‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,8 @@ const meta = {
8181
});
8282
</script>
8383
<!-- Analytics -->
84-
<script
85-
type="text/partytown"
86-
defer
87-
data-domain="next.skeleton.dev"
88-
src="https://events.plygrnd.org/js/script.outbound-links.js"
89-
is:inline></script>
84+
<script type="text/partytown" defer data-domain="skeleton.dev" src="https://events.plygrnd.org/js/script.outbound-links.js" is:inline
85+
></script>
9086
<script>
9187
declare global {
9288
interface Window {

0 commit comments

Comments
 (0)