docs(kilo-docs): scaffold Gastown documentation section

Add initial page structure for /code-with-ai/gastown/ with overview,
quick-start, concepts, mayor, sling-work, code-review, settings, and
troubleshooting pages. Register the section in the sidebar nav config.
This commit is contained in:
John Fawcett
2026-04-30 13:03:07 -05:00
parent a1c79891c1
commit 1e2aca357b
9 changed files with 173 additions and 0 deletions
@@ -62,6 +62,19 @@ export const CodeWithAiNav: NavSection[] = [
},
],
},
{
title: "Gastown",
links: [
{ href: "/code-with-ai/gastown", children: "Overview" },
{ href: "/code-with-ai/gastown/quick-start", children: "Quick Start" },
{ href: "/code-with-ai/gastown/concepts", children: "Concepts" },
{ href: "/code-with-ai/gastown/mayor", children: "The Mayor" },
{ href: "/code-with-ai/gastown/sling-work", children: "Sling Work" },
{ href: "/code-with-ai/gastown/code-review", children: "Code Review" },
{ href: "/code-with-ai/gastown/settings", children: "Settings" },
{ href: "/code-with-ai/gastown/troubleshooting", children: "Troubleshooting" },
],
},
{
title: "Productivity Tools",
links: [
@@ -0,0 +1,20 @@
---
title: "Code Review"
description: "How the refinery agent reviews and merges code"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: Review flow, merge strategies, approval gates -->
## The Review Pipeline
## Merge Strategies
### Direct Merge
### Pull Request Mode
## Review Configuration
## Handling Review Feedback
@@ -0,0 +1,24 @@
---
title: "Concepts"
description: "Understand the building blocks of Gastown — towns, beads, convoys, rigs, and agents"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: Detailed explanation of each concept with diagrams -->
## Towns
## Beads
## Convoys
## Rigs
## Agents
### Polecats (Coding Agents)
### The Refinery (Review Agent)
### The Mayor (Coordination Agent)
@@ -0,0 +1,36 @@
---
title: "Gastown"
description: "Autonomous AI agent orchestration for your codebase"
---
# {% $markdoc.frontmatter.title %}
Gastown is an autonomous agent orchestration platform that manages multiple AI agents working on your codebase. It coordinates polecats (coding agents), a refinery (code review agent), and a mayor (coordination agent) to handle tasks, code reviews, and merges — all without constant human oversight.
## Core Concepts
- **Towns** — A workspace that connects to your repository and manages agents working on it
- **Beads** — Units of work (issues, tasks, reviews) that agents pick up and complete
- **Convoys** — Multi-step workflows that chain beads together in a dependency graph
- **Rigs** — Repository connections within a town, each with their own agents and configuration
- **The Mayor** — Your primary interface to the town; a conversational agent that coordinates work and answers questions
## How It Works
1. **Create a town** and connect it to your repository
2. **Sling work** — describe what you need done, and agents autonomously pick it up
3. **Agents collaborate** — polecats write code, the refinery reviews and merges, the mayor coordinates
4. **You stay in control** — review PRs, adjust settings, intervene when needed
## Getting Started
- [Quick Start](/code-with-ai/gastown/quick-start) — Get your first town running in minutes
- [Concepts](/code-with-ai/gastown/concepts) — Understand towns, beads, convoys, and agents
- [The Mayor](/code-with-ai/gastown/mayor) — How to interact with your town's coordinator
## Guides
- [Sling Work](/code-with-ai/gastown/sling-work) — Creating tasks and convoys for agents
- [Code Review](/code-with-ai/gastown/code-review) — How the refinery reviews and merges code
- [Settings](/code-with-ai/gastown/settings) — Configure models, merge strategies, and agent behavior
- [Troubleshooting](/code-with-ai/gastown/troubleshooting) — Common issues and how to resolve them
@@ -0,0 +1,16 @@
---
title: "The Mayor"
description: "How to interact with your town's coordination agent"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: Mayor capabilities, conversation patterns, commands -->
## What the Mayor Does
## Talking to the Mayor
## Mayor Commands
## Tips for Effective Communication
@@ -0,0 +1,8 @@
---
title: "Quick Start"
description: "Get your first Gastown town running in minutes"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: Step-by-step guide to creating a town and seeing agents work -->
@@ -0,0 +1,20 @@
---
title: "Settings"
description: "Configure models, merge strategies, and agent behavior"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: All configurable settings with explanations -->
## Models
## Merge Strategy
## Refinery Configuration
## Agent Limits
## Environment Variables
## Custom Instructions
@@ -0,0 +1,18 @@
---
title: "Sling Work"
description: "Creating tasks and convoys for agents to work on"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: How to create beads, convoys, staged work -->
## Creating a Single Task
## Creating a Convoy
## Staged Convoys
## Assigning Priority
## Watching Progress
@@ -0,0 +1,18 @@
---
title: "Troubleshooting"
description: "Common issues and how to resolve them"
---
# {% $markdoc.frontmatter.title %}
<!-- TODO: Common failure modes and fixes -->
## Agents Not Picking Up Work
## Container Not Starting
## Git Authentication Failures
## Review Loop Issues
## The Mayor is Unresponsive