The shared source for Stack's user guides, language reference, and coding-agent guidance. Stack turns text into architecture diagrams with consistent themes and fast, local rendering. This repository keeps the instructions used by people, the website, and coding agents in sync.
Start with your first diagram,
browse the example gallery, or try the
Playground. Examples render from canonical .stack
source in your browser; they are not separately maintained SVG exports.
Install the Stack skill through the official CLI repository:
npx skills add stack-sh/cliThe skill teaches an agent to write, check, format, and render Stack diagrams with the CLI. Its instructions are generated here from the same agent workflow published in the docs. Installing a skill does not install the Stack CLI; follow the CLI installation guide too.
The public machine resource index provides versioned discovery for schemas, syntax highlighting, diagnostics, canonical examples, and implementation capabilities. Use it to find immutable, hash-verified resources rather than scraping documentation pages.
See Machine resource distribution for the contract and the working consumer example. A versioned capability snapshot is immutable; it is not an alias for the latest CLI.
| Source here | Consumer | Published result |
|---|---|---|
Guides and reference in content/site/ |
stack-sh/web | The four-language documentation site |
content/agent-workflow.md |
Web and stack-sh/cli | The readable agent workflow and installable skill |
| Machine resource definitions | Web | The public machine resource index and versioned manifests |
The deterministic generator produces generated/ and a SHA-256 manifest.
Consumers pin a reviewed commit and verify the generated bytes. Updating this
repository does not by itself deploy the website or publish a CLI binary.
Language semantics, schemas, and canonical example sources are owned by stack-sh/specification. The engine owns layout and rendering; Web owns presentation and deployment; CLI owns native command behavior.
Use Node.js 22 or newer:
npm ci --ignore-scripts
npm run generate
npm test
npm run check
npm run machine:checkEdit content/, not generated/, and commit source and generated changes
together. See Contributing for source ownership, release
synchronization, consumer updates, and verification.
Bug reports and documentation improvements are welcome through
issues and pull requests.