Update docs

lorenzolewis · May 21, 2024 · eda843a · eda843a
1 parent 7d2b7f1
commit eda843a
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 10 deletions.
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,6 +1,5 @@
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
-import starlightUtils from "@lorenzo_lewis/starlight-utils";
 import starlightLinksValidatorPlugin from "starlight-links-validator";
 
 // https://astro.build/config
@@ -15,15 +14,14 @@ export default defineConfig({
       sidebar: [
         {
           label: "Docs",
-          autogenerate: { directory: "docs" },
+          autogenerate: { directory: "/docs" },
         },
         {
-          label: "Samples",
-          autogenerate: { directory: "sample" },
-          badge: "Demo",
+          label: "References",
+          autogenerate: { directory: "/references" },
         },
       ],
-      plugins: [starlightUtils(), starlightLinksValidatorPlugin()],
+      plugins: [starlightLinksValidatorPlugin()],
     }),
   ],
 });
diff --git a/docs/src/content/docs/_quick-start.mdx b/docs/src/content/docs/_quick-start.mdx
@@ -27,6 +27,6 @@ import { PackageManagers } from "starlight-package-managers";
     });
     ```
 
-4.  All done! ✨
+4.  Go to the [Configuration Guide](/configuration) to continue setting up! ✨
 
 </Steps>
diff --git a/docs/src/content/docs/docs/configuration.md → docs/src/content/docs/configuration.md b/docs/src/content/docs/docs/configuration.md → docs/src/content/docs/configuration.md
diff --git a/docs/src/content/docs/docs/configuration.mdx b/docs/src/content/docs/docs/configuration.mdx
@@ -0,0 +1,3 @@
+---
+title: Configuration
+---
diff --git a/docs/src/content/docs/docs/recommended.mdx b/docs/src/content/docs/docs/recommended.mdx
@@ -0,0 +1,3 @@
+---
+title: Recommended Plugins
+---
diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx
@@ -1,17 +1,27 @@
 ---
 title: 🧰 Starlight Utils
-description: Enable multiple sidebars with your Starlight site.
+description: A collection of utilities to build on top of your 🌟 Starlight site.
+tableOfContents: false
+template: splash
 hero:
-  tagline: Enable multiple sidebars with your Starlight site.
+  tagline: A collection of utilities to build on top of your 🌟 Starlight site.
   image:
     file: ../../assets/houston.webp
   actions:
     - text: Get Started
-      link: /docs/
+      link: /docs
       icon: right-arrow
       variant: primary
 ---
 
+import { LinkCard, CardGrid } from "@astrojs/starlight/components";
+
+<CardGrid stagger>
+  <LinkCard />
+  <LinkCard />
+  <LinkCard />
+</CardGrid>
+
 import QuickStart from "./_quick-start.mdx";
 
 ## Quick Start

diff --git a/docs/src/content/docs/docs/changelog.mdx → ...src/content/docs/references/changelog.mdx b/docs/src/content/docs/docs/changelog.mdx → ...src/content/docs/references/changelog.mdx
diff --git a/docs/src/content/docs/references/index.mdx b/docs/src/content/docs/references/index.mdx
@@ -0,0 +1,5 @@
+---
+title: References
+sidebar:
+  order: 1
+---