Skip to content

Commit ea3cbb5

Browse files
FL4TLiN3claude
andauthored
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>
1 parent c77034a commit ea3cbb5

34 files changed

+85
-503
lines changed

docs/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Perstack: The Agent Runtime"
44

55
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.
66

7-
- [Getting Started →](./getting-started.md)
7+
- [Getting Started →](./getting-started/walkthrough.md)
88
- [Browse Registry →](https://platform.perstack.ai/)
99

1010
## What Perstack Solves
@@ -66,25 +66,23 @@ const checkpoint = await run({
6666

6767
### Learn
6868

69-
- [Getting Started](./getting-started.md) — create your first Expert and walk through the core workflow
69+
- [Getting Started](./getting-started/walkthrough.md) — create your first Expert and walk through the core workflow
7070
- **Understanding Perstack**
7171
- [Concept](./understanding-perstack/concept.md) — the architecture behind the runtime
7272
- [Experts](./understanding-perstack/experts.md) — what Experts are and how they work
7373
- [Runtime](./understanding-perstack/runtime.md) — execution model and event system
7474
- [Sandbox Integration](./understanding-perstack/sandbox-integration.md) — infrastructure-level isolation
7575
- [Boundary Model](./understanding-perstack/boundary-model.md) — trust boundaries between components
76-
- [Registry](./understanding-perstack/registry.md) — publishing and discovering Experts
7776

7877
### Build
7978

80-
- **[Making Experts](./making-experts/README.md)** — complete guide to Expert definitions
79+
- **[Making Experts](./making-experts/best-practices.md)** — complete guide to Expert definitions
8180
- [Examples](./making-experts/examples.md) — real-world use cases
8281
- [Best Practices](./making-experts/best-practices.md) — design guidelines for effective Experts
8382
- [Skills](./making-experts/skills.md) — adding MCP tools to your Experts
8483
- [Base Skill](./making-experts/base-skill.md) — built-in tools provided by the runtime
8584
- [Testing](./making-experts/testing.md) — strategies for testing Experts
86-
- [Publishing](./making-experts/publishing.md) — share Experts via the Registry
87-
- **[Guides](./guides/README.md)** — task-oriented walkthroughs
85+
- **[Guides](./guides/rapid-prototyping.md)** — task-oriented walkthroughs
8886
- [Rapid Prototyping](./guides/rapid-prototyping.md) — validate ideas without writing code
8987
- [Taming Prompt Sprawl](./guides/taming-prompt-sprawl.md) — fix bloated prompts with modular Experts
9088
- [Extending with Tools](./guides/extending-with-tools.md) — give your Experts real-world capabilities via MCP
@@ -93,7 +91,7 @@ const checkpoint = await run({
9391

9492
### Run
9593

96-
- **[Using Experts](./using-experts/README.md)** — run and integrate Experts
94+
- **[Using Experts](./using-experts/running-experts.md)** — run and integrate Experts
9795
- [Running Experts](./using-experts/running-experts.md) — CLI commands and runtime API
9896
- [Workspace](./using-experts/workspace.md) — file system layout and conventions
9997
- [State Management](./using-experts/state-management.md) — checkpoints, pausing, resuming
Lines changed: 23 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
2-
title: "Getting Started"
2+
title: "Walkthrough"
3+
sidebar:
4+
order: 1
35
---
46

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.
68

79
## Prerequisites
810

911
- [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))
1113

1214
```bash
1315
export ANTHROPIC_API_KEY=sk-ant-...
1416
```
1517

16-
## Step 1: Create an Expert
17-
18-
> [!TIP]
19-
> **Addresses**: Tight coupling, The developer owns everything
18+
## Create an Expert
2019

2120
Generate an Expert definition interactively:
2221

@@ -51,10 +50,7 @@ instruction = "Provide split routines and HIIT plans tailored to user history."
5150

5251
You can also write `perstack.toml` manually — `create-expert` is a convenient starting point, not a requirement.
5352

54-
## Step 2: Run Your Expert
55-
56-
> [!TIP]
57-
> **Addresses**: Broken feedback loops
53+
## Run Your Expert
5854

5955
### Interactive mode
6056

@@ -76,15 +72,12 @@ npx perstack run fitness-assistant "Start today's session"
7672

7773
| Aspect | What Perstack Does |
7874
| --- | --- |
79-
| **Isolation** | Each Expert has its own context window. No prompt bloat. |
75+
| **State** | Both Experts share the workspace (`./fitness-log.md`), not conversation history. |
8076
| **Collaboration** | `fitness-assistant` delegates to `pro-trainer` autonomously. |
8177
| **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. |
8579

86-
> [!TIP]
87-
> **Addresses**: No sustained behavior (observability)
80+
## Analyze Execution
8881

8982
After running an Expert, inspect what happened:
9083

@@ -106,12 +99,9 @@ Key options for deeper inspection:
10699

107100
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.
108101

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.
110103

111-
## Step 4: Lock for Reproducibility
112-
113-
> [!TIP]
114-
> **Addresses**: No sustained behavior (reproducibility)
104+
## Lock for Reproducibility
115105

116106
```bash
117107
npx perstack install
@@ -128,10 +118,7 @@ This creates a `perstack.lock` file that caches tool schemas for all MCP skills.
128118

129119
The lockfile is optional. If not present, skills are initialized at runtime as usual.
130120

131-
## Step 5: Integrate into Your Application
132-
133-
> [!TIP]
134-
> **Addresses**: No real isolation
121+
## Integrate into Your Application
135122

136123
The CLI is for prototyping. For production, integrate Experts into your application via the Execution API, sandbox providers, or runtime embedding.
137124

@@ -227,7 +214,7 @@ Perstack's isolation model maps naturally to container and serverless platforms:
227214
- Kubernetes
228215
- Cloudflare Workers
229216

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.
231218

232219
### Runtime Embedding (`@perstack/runtime`)
233220

@@ -269,16 +256,16 @@ The CLI is for prototyping. The runtime API is for production. Both use the same
269256
## What's Next
270257

271258
**Build more:**
272-
- [Making Experts](./making-experts/README.md) — full `perstack.toml` guide
273-
- [Skills](./making-experts/skills.md) — MCP integration patterns
274-
- [Taming Prompt Sprawl](./guides/taming-prompt-sprawl.md) — break monolithic prompts into collaborating Experts
259+
- [Making Experts](../making-experts/best-practices.md) — full `perstack.toml` guide
260+
- [Skills](../making-experts/skills.md) — MCP integration patterns
261+
- [Taming Prompt Sprawl](../guides/taming-prompt-sprawl.md) — break monolithic prompts into collaborating Experts
275262

276263
**Understand the architecture:**
277-
- [Concept](./understanding-perstack/concept.md) — why isolation and observability matter
278-
- [Experts](./understanding-perstack/experts.md) — best practices for Expert design
279-
- [Sandbox Integration](./understanding-perstack/sandbox-integration.md) — infrastructure-level isolation
264+
- [Concept](../understanding-perstack/concept.md) — why isolation and observability matter
265+
- [Experts](../understanding-perstack/experts.md) — best practices for Expert design
266+
- [Sandbox Integration](../understanding-perstack/sandbox-integration.md) — infrastructure-level isolation
280267

281268
**Reference:**
282-
- [CLI Reference](./references/cli.md) — all commands and options
283-
- [perstack.toml Reference](./references/perstack-toml.md) — complete configuration spec
284-
- [Events](./references/events.md) — runtime event schema
269+
- [CLI Reference](../references/cli.md) — all commands and options
270+
- [perstack.toml Reference](../references/perstack-toml.md) — complete configuration spec
271+
- [Events](../references/events.md) — runtime event schema

docs/guides/README.md

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

docs/guides/adding-ai-to-your-app.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "Adding AI to Your App"
33
description: "Embed AI capabilities into your existing application. Your app stays in control while Perstack handles execution."
44
tags: ["integration", "container", "events"]
5-
order: 2
5+
sidebar:
6+
order: 2
67
---
78

89
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.

docs/guides/extending-with-tools.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "Extending with Tools"
33
description: "Give your agent access to web search, databases, and APIs using MCP skills. Declare tools in TOML, the runtime handles the rest."
44
tags: ["tools", "mcp", "skills"]
5-
order: 3
5+
sidebar:
6+
order: 3
67
---
78

89
Your agent can reason and generate text. But sometimes that's not enough — you need it to search the web, query a database, or call an API.

docs/guides/going-to-production.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "Going to Production"
33
description: "Deploy your agent safely and reliably. Sandbox execution in containers with full observability."
44
tags: ["deployment", "container", "production"]
5-
order: 5
5+
sidebar:
6+
order: 5
67
---
78

89
Your agent works in development. Now you want to deploy it for real users.

docs/guides/rapid-prototyping.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "Prototyping for Agent-First Apps"
33
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."
44
tags: ["beginner", "quick-start", "create-expert"]
5-
order: 1
5+
sidebar:
6+
order: 1
67
---
78

89
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
129130

130131
## What's next
131132

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
133134
- [Best Practices](../making-experts/best-practices.md) — Design patterns for effective Experts

docs/guides/taming-prompt-sprawl.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "Taming Prompt Sprawl"
33
description: "Fix bloated prompts and confused agents. Split responsibilities across focused Experts using delegation."
44
tags: ["prompts", "delegation", "architecture"]
5-
order: 4
5+
sidebar:
6+
order: 4
67
---
78

89
Your agent started simple. A focused prompt, clear behavior, reliable results.

docs/making-experts/README.md

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

docs/making-experts/base-skill.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Base Skill"
3+
sidebar:
4+
order: 3
35
---
46

57
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

Comments
 (0)