Skip to content

Commit a3467b6

Browse files
feat: added the docs pages
1 parent 69905fd commit a3467b6

File tree

17 files changed

+129
-7
lines changed

17 files changed

+129
-7
lines changed

docs/astro.config.mjs

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,71 @@ import starlight from "@astrojs/starlight";
44

55
// https://astro.build/config
66
export default defineConfig({
7+
site: "https://muppet.dev",
8+
redirects: {
9+
"/": {
10+
status: 301,
11+
destination: "/introduction",
12+
},
13+
},
714
integrations: [
815
starlight({
916
title: "muppet",
17+
logo: {
18+
light: "./src/assets/logo-light.png",
19+
dark: "./src/assets/logo-dark.png",
20+
replacesTitle: true,
21+
},
1022
social: {
23+
blueSky: "https://bsky.app/profile/muppet.dev",
24+
"x.com": "https://x.com/muppetdev",
1125
github: "https://github.com/muppet-dev/muppet",
1226
},
27+
editLink: {
28+
baseUrl: "https://github.com/muppet-dev/muppet/tree/main/docs",
29+
},
30+
sidebar: [
31+
{
32+
label: "Getting Started",
33+
items: [
34+
{ label: "Introduction", slug: "introduction" },
35+
{
36+
label: "Quickstart",
37+
items: [
38+
{
39+
label: "For Server Developers",
40+
slug: "quickstart/server",
41+
},
42+
{
43+
label: "For Users",
44+
slug: "quickstart/user",
45+
},
46+
],
47+
},
48+
{ label: "Examples", slug: "examples" },
49+
],
50+
},
51+
{
52+
label: "Tutorials",
53+
items: [
54+
{ label: "Debugging", slug: "tutorials/debugging" },
55+
{ label: "Inspector", slug: "tutorials/inspector" },
56+
],
57+
},
58+
{
59+
label: "Concepts",
60+
items: [
61+
{ label: "Core architecture", slug: "concepts/architecture" },
62+
{ label: "Resources", slug: "concepts/resources" },
63+
{ label: "Prompts", slug: "concepts/prompts" },
64+
{ label: "Tools", slug: "concepts/tools" },
65+
],
66+
},
67+
{
68+
label: "Development",
69+
items: [{ label: "Contributing", slug: "development/contributing" }],
70+
},
71+
],
1372
}),
1473
],
1574
});

docs/src/assets/banner.png

311 KB
Loading

docs/src/assets/houston.webp

-96.2 KB
Binary file not shown.

docs/src/assets/logo-dark.png

7.82 KB
Loading

docs/src/assets/logo-light.png

7.23 KB
Loading
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Architecture
3+
description: Get started with muppet
4+
---
5+
6+
WIP
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Prompts
3+
description: Get started with muppet
4+
---
5+
6+
WIP
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Resources
3+
description: Get started with muppet
4+
---
5+
6+
WIP
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Tools
3+
description: Get started with muppet
4+
---
5+
6+
WIP
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Contributing
3+
description: Get started with muppet
4+
---
5+
6+
WIP

0 commit comments

Comments
 (0)