Skip to content

Commit cb5de9e

Browse files
committed
docs: migrate docs to Astro Starlight
1 parent 671616d commit cb5de9e

26 files changed

Lines changed: 9018 additions & 4803 deletions

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
node_modules/
33
.npm-cache/
44
dist/
5-
docs/.vitepress/cache/
6-
docs/.vitepress/dist/
5+
docs/.astro/
76
packages/*/dist/
87
packages/*/temp/
98
coverage/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@ Runnable examples live in [`examples/`](./examples/) and are indexed in [`exampl
3333
## Docs
3434

3535
- [Public Docs](https://execbox.aallam.com)
36-
- [Getting Started Guide](./docs/getting-started.md)
37-
- [Execbox Architecture Overview](./docs/architecture/README.md)
36+
- [Getting Started Guide](./docs/src/content/docs/getting-started.md)
37+
- [Execbox Architecture Overview](./docs/src/content/docs/architecture/index.md)

docs/.vitepress/config.ts

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/.vitepress/theme/custom.css

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/.vitepress/theme/index.ts

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/architecture/README.md

Lines changed: 0 additions & 102 deletions
This file was deleted.

docs/astro.config.mjs

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
import starlight from "@astrojs/starlight";
2+
import { defineConfig } from "astro/config";
3+
import mermaid from "astro-mermaid";
4+
5+
export default defineConfig({
6+
site: "https://execbox.aallam.com",
7+
integrations: [
8+
mermaid({
9+
autoTheme: true,
10+
enableLog: false,
11+
mermaidConfig: {
12+
securityLevel: "loose",
13+
},
14+
}),
15+
starlight({
16+
title: "execbox",
17+
description:
18+
"Portable code execution for MCP tools and wrapped MCP servers.",
19+
customCss: ["/src/styles/custom.css"],
20+
lastUpdated: true,
21+
pagefind: true,
22+
social: [
23+
{
24+
icon: "github",
25+
label: "GitHub",
26+
href: "https://github.com/aallam/execbox",
27+
},
28+
],
29+
sidebar: [
30+
{
31+
label: "Start",
32+
items: [
33+
{ label: "Overview", link: "/" },
34+
{ label: "Getting Started", slug: "getting-started" },
35+
{ label: "Runtime Choices", slug: "runtime-choices" },
36+
],
37+
},
38+
{
39+
label: "Use",
40+
items: [
41+
{ label: "Examples", slug: "examples" },
42+
{
43+
label: "MCP Provider",
44+
slug: "architecture/execbox-mcp-and-protocol",
45+
},
46+
{
47+
label: "Remote Runner",
48+
slug: "architecture/execbox-remote-workflow",
49+
},
50+
],
51+
},
52+
{
53+
label: "Understand",
54+
items: [
55+
{ label: "Security", slug: "security" },
56+
{ label: "Architecture", slug: "architecture" },
57+
{ label: "Performance", slug: "performance" },
58+
],
59+
},
60+
{
61+
label: "Reference",
62+
items: [
63+
{
64+
label: "Protocol",
65+
slug: "architecture/execbox-protocol-reference",
66+
},
67+
{
68+
label: "Runner Specification",
69+
slug: "architecture/execbox-runner-specification",
70+
},
71+
],
72+
},
73+
],
74+
}),
75+
],
76+
});

docs/index.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

docs/src/content.config.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineCollection } from "astro:content";
2+
import { docsLoader } from "@astrojs/starlight/loaders";
3+
import { docsSchema } from "@astrojs/starlight/schema";
4+
5+
export const collections = {
6+
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
7+
};

docs/architecture/execbox-core.md renamed to docs/src/content/docs/architecture/execbox-core.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Execbox Core Architecture
1+
---
2+
title: Execbox Core Architecture
3+
description: Provider resolution, execution contracts, shared runner semantics, and errors in execbox core.
4+
---
25

36
This page covers the parts of execbox that stay stable regardless of which executor package you choose.
47

0 commit comments

Comments
 (0)