Sortie Documentation

Source for docs.sortie-ai.com

Sortie turns issue tracker tickets into autonomous coding agent sessions. This repository contains all the source code and content for the Sortie documentation site.

Read the Docs · Report an Issue · Main Repository

---

About Sortie

Sortie is an autonomous coding agent orchestrator. Engineers manage work at the ticket level — Sortie handles the rest: isolated workspaces, retry logic, state reconciliation, tracker integration, and cost tracking. Single binary, zero dependencies, SQLite persistence.

For a full overview, see the product documentation.

Tech Stack

Component	Details
Static site generator	Hugo ≥ 0.146.0 (extended)
Theme	Hextra v0.12.1 (Tailwind CSS, FlexSearch)
Markdown renderer	Goldmark with KaTeX math support
Deployment	Cloudflare Workers (static assets via Wrangler)
Analytics	Google Analytics GA4 with GDPR-compliant cookie consent

Prerequisites

• Hugo ≥ 0.146.0 extended version
• Go ≥ 1.20 — required by Hugo Modules (theme dependency management)
• Git — required for enableGitInfo (last-modified dates)
• Node.js — required for Wrangler deployment

Local Development

Clone the repository and start the dev server. Hugo automatically downloads the Hextra theme on first run:

git clone https://github.com/sortie-ai/sortie-docs.git
cd sortie-docs

hugo server \
  --environment development \
  --logLevel info \
  --buildDrafts \
  --buildFuture \
  --ignoreCache \
  --disableFastRender

# Or use the npm script
npm run server

Open http://localhost:1313 in your browser. Hugo watches for file changes and reloads automatically.

Build for Production

hugo \
  --environment production \
  --gc \
  --logLevel info \
  --minify \
  --cleanDestinationDir \
  --printPathWarnings \
  --printMemoryUsage

# Or use the npm script
npm run build

The generated static site in public/ is deployed to Cloudflare Workers via Wrangler:

npx wrangler deploy

Repository Structure

sortie-docs/
├── content/                     # All documentation content (Markdown)
│   ├── _index.md                # Homepage
│   ├── changelog.md             # Release history
│   ├── concepts/                # Conceptual explanations
│   ├── getting-started/         # Installation, Quick Start, Jira Integration, End-to-End
│   ├── guides/                  # How-to guides (SSH scaling, monitoring, hooks, etc.)
│   └── reference/               # CLI, Workflow config, API, Prometheus metrics, errors
├── layouts/                     # Hugo layout overrides (Go templates)
├── static/                      # Static assets
│   ├── img/                     # Images, favicons, OG image
│   ├── css/                     # Custom CSS (cookieconsent, overrides)
│   ├── js/                      # Custom JS (feedback widget, cookie consent)
│   ├── _headers                 # Cloudflare response headers
│   └── _redirects               # URL redirects
├── go.mod                       # Hugo module — pins Hextra theme version
├── go.sum                       # Module checksums
├── hugo.toml                    # Hugo configuration
├── wrangler.toml                # Cloudflare Workers deployment config
└── package.json                 # Node.js deps (Wrangler)

Contributing

We welcome contributions from the community — whether it's fixing a typo, improving a guide, or adding new content.

Quick Edits

For small fixes (typos, broken links, wording improvements), edit the file directly on GitHub and open a Pull Request.

Adding a Page

1. Create a new .md file in the appropriate content/ subdirectory.
2. Hugo picks it up automatically — no nav registration required.
3. Preview locally with hugo server.
4. Push your branch — Cloudflare deploys automatically on merge to main.

Content Guidelines

• Documentation follows the Diátaxis framework — tutorials, how-to guides, reference, and explanation are kept separate by intent.
• Write in clear, concise English aimed at senior engineers and DevOps practitioners.
• Use Hextra callout shortcodes for warnings, tips, and notes.
• Include cross-links to related pages (installation → quick start → reference).
• Every page should have title and description in its front matter.

Related

Link	Description
sortie-ai/sortie	Main project — the Sortie orchestrator binary
sortie-ai/homebrew-tap	Homebrew Tap for Sortie
Architecture spec	Internal engineering reference

License

Documentation text is licensed under CC BY 4.0. Code examples and configuration samples are licensed under Apache 2.0.

See LICENSE for full details.