Skip to content

index.mdx

Latest commit

 

History

History
39 lines (32 loc) · 1.59 KB

index.mdx

File metadata and controls

39 lines (32 loc) · 1.59 KB
Raw
title Gas City
description Contributor-facing documentation for the Gas City orchestration SDK.

Gas City is an orchestration-builder SDK for multi-agent systems. This docs tree is organized for external contributors first: install the toolchain, run a local city, find the relevant subsystem, and then decide whether you need current-state architecture docs, forward-looking design docs, or archived working notes.

Start Here

  • Installation explains the local toolchain and the shortest path to a working gc binary.
  • Quickstart walks through the smallest city you can boot locally.
  • Coming from Gas Town maps Town roles, commands, plugins, convoys, and filesystem habits onto Gas City's primitives.
  • Repository Map explains where the CLI, runtime, config, store, and controller code live.

Documentation Types

  • Tutorials: end-to-end walkthroughs that teach the user model.
  • Guides: practical docs for specific workflows like packs and Kubernetes.
  • Reference: command, config, formula, and provider lookup docs.

For contributor-facing material (architecture, design docs, and archived notes), see the engdocs/ directory in the repository.

Repository Context

Gas City is the open-source SDK extracted from Gas Town. The public docs now separate current contributor guidance from historical planning material so new readers can get oriented without reading every audit and roadmap first.