You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Docs: Fix broken internal links and add sidebar ordering (#480)
- Fix walkthrough.md relative links (./ → ../) for cross-directory refs
- Replace links to non-existent README.md files with actual first pages
- Remove publishing.md link from testing.md (file removed)
- Add sidebar order frontmatter to all doc pages for Starlight navigation
- Remove obsolete pages: getting-started.md (replaced by getting-started/walkthrough.md),
publishing.md, registry.md, and section README.md files
- Remove Key features section from concept.md (duplicated navigation)
- Fix guide frontmatter: order → sidebar.order for Starlight compatibility
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/README.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: "Perstack: The Agent Runtime"
4
4
5
5
Define AI agents as declarative **Experts** in TOML. Execute them with deterministic, event-derived tracking. Each Expert runs in its own isolated context — no shared state, no prompt bloat, full execution history.
6
6
7
-
-[Getting Started →](./getting-started.md)
7
+
-[Getting Started →](./getting-started/walkthrough.md)
Copy file name to clipboardExpand all lines: docs/getting-started/walkthrough.md
+23-36Lines changed: 23 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,21 @@
1
1
---
2
-
title: "Getting Started"
2
+
title: "Walkthrough"
3
+
sidebar:
4
+
order: 1
3
5
---
4
6
5
-
This walkthrough takes you from zero to production integration. Each step addresses one or more of the [five structural problems](../README.md#why-perstack) in agentic app development.
7
+
This walkthrough takes you from zero to production integration.
6
8
7
9
## Prerequisites
8
10
9
11
-[Node.js 22+](https://nodejs.org/)
10
-
- An LLM provider API key (see [Providers and Models](./references/providers-and-models.md))
12
+
- An LLM provider API key (see [Providers and Models](../references/providers-and-models.md))
11
13
12
14
```bash
13
15
export ANTHROPIC_API_KEY=sk-ant-...
14
16
```
15
17
16
-
## Step 1: Create an Expert
17
-
18
-
> [!TIP]
19
-
> **Addresses**: Tight coupling, The developer owns everything
18
+
## Create an Expert
20
19
21
20
Generate an Expert definition interactively:
22
21
@@ -51,10 +50,7 @@ instruction = "Provide split routines and HIIT plans tailored to user history."
51
50
52
51
You can also write `perstack.toml` manually — `create-expert` is a convenient starting point, not a requirement.
|**Isolation**|Each Expert has its own context window. No prompt bloat. |
75
+
|**State**|Both Experts share the workspace (`./fitness-log.md`), not conversation history. |
80
76
|**Collaboration**|`fitness-assistant` delegates to `pro-trainer` autonomously. |
81
77
|**Observability**| Every step is visible as a structured event. |
82
-
|**State**| Both Experts share the workspace (`./fitness-log.md`), not conversation history. |
83
-
84
-
## Step 3: Analyze Execution
78
+
|**Isolation**| Each Expert has its own context window. No prompt bloat. |
85
79
86
-
> [!TIP]
87
-
> **Addresses**: No sustained behavior (observability)
80
+
## Analyze Execution
88
81
89
82
After running an Expert, inspect what happened:
90
83
@@ -106,12 +99,9 @@ Key options for deeper inspection:
106
99
107
100
This matters because debugging agents across model changes, requirement changes, and prompt iterations requires visibility into every decision the agent made. `perstack log` gives you that visibility without adding instrumentation code.
108
101
109
-
See [CLI Reference](./references/cli.md#perstack-log) for the full list of options.
102
+
See [CLI Reference](../references/cli.md#perstack-log) for the full list of options.
110
103
111
-
## Step 4: Lock for Reproducibility
112
-
113
-
> [!TIP]
114
-
> **Addresses**: No sustained behavior (reproducibility)
104
+
## Lock for Reproducibility
115
105
116
106
```bash
117
107
npx perstack install
@@ -128,10 +118,7 @@ This creates a `perstack.lock` file that caches tool schemas for all MCP skills.
128
118
129
119
The lockfile is optional. If not present, skills are initialized at runtime as usual.
130
120
131
-
## Step 5: Integrate into Your Application
132
-
133
-
> [!TIP]
134
-
> **Addresses**: No real isolation
121
+
## Integrate into Your Application
135
122
136
123
The CLI is for prototyping. For production, integrate Experts into your application via the Execution API, sandbox providers, or runtime embedding.
137
124
@@ -227,7 +214,7 @@ Perstack's isolation model maps naturally to container and serverless platforms:
227
214
- Kubernetes
228
215
- Cloudflare Workers
229
216
230
-
Each Expert runs in its own sandboxed environment. See [Going to Production](./guides/going-to-production.md) for the Docker setup pattern. Detailed guides for other providers are coming soon.
217
+
Each Expert runs in its own sandboxed environment. See [Going to Production](../guides/going-to-production.md) for the Docker setup pattern. Detailed guides for other providers are coming soon.
231
218
232
219
### Runtime Embedding (`@perstack/runtime`)
233
220
@@ -269,16 +256,16 @@ The CLI is for prototyping. The runtime API is for production. Both use the same
269
256
## What's Next
270
257
271
258
**Build more:**
272
-
-[Making Experts](./making-experts/README.md) — full `perstack.toml` guide
Copy file name to clipboardExpand all lines: docs/guides/adding-ai-to-your-app.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
title: "Adding AI to Your App"
3
3
description: "Embed AI capabilities into your existing application. Your app stays in control while Perstack handles execution."
4
4
tags: ["integration", "container", "events"]
5
-
order: 2
5
+
sidebar:
6
+
order: 2
6
7
---
7
8
8
9
You have an existing application — maybe a web app, a CLI tool, or a backend service. You want to add AI capabilities, but you're not sure where to start.
Copy file name to clipboardExpand all lines: docs/guides/rapid-prototyping.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
title: "Prototyping for Agent-First Apps"
3
3
description: "Start with the agent, not the app. Use create-expert to go from idea to working agent in seconds, then expand to tools and applications."
When you build an agent-powered app, the instinct is to start with the app — set up a project, install dependencies, write scaffolding. Then somewhere in the middle, you start figuring out what the agent should actually do.
@@ -129,5 +130,5 @@ At some point, your prototype will need more. The same `perstack.toml` scales
129
130
130
131
## What's next
131
132
132
-
-[Making Experts](../making-experts/README.md) — Learn the full Expert definition format
133
+
-[Making Experts](../making-experts/best-practices.md) — Learn the full Expert definition format
133
134
-[Best Practices](../making-experts/best-practices.md) — Design patterns for effective Experts
Copy file name to clipboardExpand all lines: docs/making-experts/base-skill.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
---
2
2
title: "Base Skill"
3
+
sidebar:
4
+
order: 3
3
5
---
4
6
5
7
Every Expert automatically has access to `@perstack/base` — a built-in skill that provides file operations, runtime control, and other essential tools.
0 commit comments