diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index ba709327..00000000 --- a/docs/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Perstack Documentation -description: A harness for micro-agents — build practical agentic apps that are cheaper and easier to operate. -slug: docs -pagefind: true ---- - -Perstack is an open-source harness for micro-agents — purpose-specific agents with a single responsibility. - -Instead of one monolithic agent on a frontier model, you define a team of small, focused agents in TOML, and the runtime handles orchestration, isolation, and state. The result: agentic apps that are cheaper to run and easier to operate. - -## Quick Start - -Use the built-in `create-expert` expert to scaffold a micro-agent team, then run it: - -```bash -# Scaffold a micro-agent team -docker run --pull always --rm -it \ - -e FIREWORKS_API_KEY \ - -v ./my-project:/workspace \ - perstack/perstack start create-expert \ - --provider fireworks \ - --model accounts/fireworks/models/kimi-k2p5 \ - "Form a team to build a CLI app." - -# Run the generated expert -docker run --pull always --rm -it \ - -e FIREWORKS_API_KEY \ - -v ./my-project:/workspace \ - perstack/perstack start my-expert \ - --provider fireworks \ - --model accounts/fireworks/models/kimi-k2p5 \ - "Build me a CLI todo app with priorities and due dates." -``` - -See [Getting Started](/docs/getting-started/walkthrough/) for a full walkthrough. - -## Why Micro-Agents? - -| | | -| :--- | :--- | -| **Cost-effective** | Purpose-specific agents run on affordable models. A focused agent on a cheap model outperforms a generalist on an expensive one. | -| **Fast** | Smaller models generate faster. Fine-grained tasks run concurrently via parallel delegation. | -| **Reusable** | Delegates are dependency management for agents — like npm packages or crates. Compose purpose-built experts across projects. | -| **Maintainable** | Single-responsibility experts are independently testable. Test each one, then compose them. | - -## Explore the Docs - -### Learn - -- [**Getting Started**](/docs/getting-started/walkthrough/) — create your first expert and walk through the core workflow -- [**Concepts**](/docs/understanding-perstack/concept/) — understand the architecture behind experts, runtime, isolation, and the boundary model - -### Build - -- [**Making Experts**](/docs/making-experts/best-practices/) — defining experts with skills, delegation, testing, and best practices -- [**Guides**](/docs/guides/rapid-prototyping/) — task-oriented walkthroughs from rapid prototyping to production deployment - -### Operate - -- [**Deployment**](/docs/operating-experts/deployment/) — container images, serverless integration, and `perstack install` -- [**Isolation & Security**](/docs/operating-experts/isolation-by-design/) — sandbox design, workspace boundaries, and secret management - -### Reference - -- [**CLI Reference**](/docs/references/cli/) — all commands and options for the Perstack CLI -- [**perstack.toml Reference**](/docs/references/perstack-toml/) — complete configuration specification -- [**Providers and Models**](/docs/references/providers-and-models/) — supported providers and model configuration - -## Community - -- [GitHub](https://github.com/perstack-ai/perstack) — source code and issues -- [Discord](https://discord.gg/2xZzrxC9) — chat with the community -- [@FL4T_LiN3 on X](https://x.com/FL4T_LiN3) — updates and announcements diff --git a/docs/index.mdx b/docs/index.mdx new file mode 100644 index 00000000..b31b1b24 --- /dev/null +++ b/docs/index.mdx @@ -0,0 +1,39 @@ +--- +title: Perstack Documentation +description: A harness for micro-agents — build practical agentic apps that are cheaper and easier to operate. +slug: docs +pagefind: true +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Perstack is a harness for micro-agents. + +## Explore the Docs + +### Learn + +- [**Getting Started**](/docs/getting-started/walkthrough/) — create your first expert and walk through the core workflow +- [**Concepts**](/docs/understanding-perstack/concept/) — understand the architecture behind experts, runtime, isolation, and the boundary model + +### Build + +- [**Making Experts**](/docs/making-experts/best-practices/) — defining experts with skills, delegation, testing, and best practices +- [**Guides**](/docs/guides/rapid-prototyping/) — task-oriented walkthroughs from rapid prototyping to production deployment + +### Operate + +- [**Deployment**](/docs/operating-experts/deployment/) — container images, serverless integration, and `perstack install` +- [**Isolation & Security**](/docs/operating-experts/isolation-by-design/) — sandbox design, workspace boundaries, and secret management + +### Reference + +- [**CLI Reference**](/docs/references/cli/) — all commands and options for the Perstack CLI +- [**perstack.toml Reference**](/docs/references/perstack-toml/) — complete configuration specification +- [**Providers and Models**](/docs/references/providers-and-models/) — supported providers and model configuration + +## Community + +- [GitHub](https://github.com/perstack-ai/perstack) — source code and issues +- [Discord](https://discord.gg/2xZzrxC9) — chat with the community +- [@FL4T_LiN3 on X](https://x.com/FL4T_LiN3) — updates and announcements