fix: feat: quickstart guide and architecture docs on disinto.ai (#394)
Add two documentation pages to the site: - site/docs/quickstart.html — prerequisites, disinto init walkthrough, first issue lifecycle demo - site/docs/architecture.html — agent loop diagram, phase protocol, vault/quality gate, planner+predictor feedback cycle Both pages are linked from the landing page navigation and footer. Sitemap updated with new URLs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
631563e58a
commit
234785144d
5 changed files with 1089 additions and 2 deletions
546
site/docs/architecture.html
Normal file
546
site/docs/architecture.html
Normal file
|
|
@ -0,0 +1,546 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Architecture — Disinto</title>
|
||||
<meta name="description" content="How Disinto works: agent loop, phase protocol, vault safety gates, and the planner-predictor feedback cycle.">
|
||||
<link rel="icon" href="../favicon.ico" sizes="32x32">
|
||||
<link rel="icon" href="../favicon-192.png" sizes="192x192" type="image/png">
|
||||
<link rel="apple-touch-icon" href="../apple-touch-icon.png">
|
||||
<link rel="canonical" href="https://disinto.ai/docs/architecture">
|
||||
<meta property="og:title" content="Architecture — Disinto">
|
||||
<meta property="og:description" content="How Disinto works: agent loop, phase protocol, vault safety gates, and the planner-predictor feedback cycle.">
|
||||
<meta property="og:url" content="https://disinto.ai/docs/architecture">
|
||||
<meta property="og:type" content="article">
|
||||
<style>
|
||||
:root {
|
||||
--bg: #0a0a0a;
|
||||
--fg: #e0e0e0;
|
||||
--dim: #707070;
|
||||
--accent: #c8a46e;
|
||||
--accent-dim: #8a7044;
|
||||
--surface: #141414;
|
||||
--border: #222;
|
||||
--green: #4a7;
|
||||
--red: #a54;
|
||||
--yellow: #a93;
|
||||
}
|
||||
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
|
||||
body {
|
||||
font-family: 'SF Mono', 'Cascadia Code', 'Fira Code', 'JetBrains Mono', monospace;
|
||||
background: var(--bg);
|
||||
color: var(--fg);
|
||||
line-height: 1.7;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 720px;
|
||||
margin: 0 auto;
|
||||
padding: 3rem 2rem;
|
||||
}
|
||||
|
||||
/* Header */
|
||||
.header {
|
||||
text-align: center;
|
||||
margin-bottom: 3rem;
|
||||
}
|
||||
|
||||
.header h1 {
|
||||
font-size: 2rem;
|
||||
font-weight: 300;
|
||||
letter-spacing: 0.2em;
|
||||
text-transform: uppercase;
|
||||
color: var(--accent);
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.header .subtitle {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
letter-spacing: 0.1em;
|
||||
}
|
||||
|
||||
.header .back {
|
||||
display: inline-block;
|
||||
margin-top: 0.75rem;
|
||||
color: var(--accent-dim);
|
||||
text-decoration: none;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.header .back:hover { color: var(--accent); }
|
||||
|
||||
/* Navigation between docs */
|
||||
.doc-nav {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
gap: 1.5rem;
|
||||
margin-bottom: 2.5rem;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.doc-nav a {
|
||||
color: var(--accent-dim);
|
||||
text-decoration: none;
|
||||
padding: 0.3rem 0.8rem;
|
||||
border: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.doc-nav a:hover { border-color: var(--accent-dim); }
|
||||
|
||||
.doc-nav a.active {
|
||||
color: var(--accent);
|
||||
border-color: var(--accent-dim);
|
||||
}
|
||||
|
||||
/* Section */
|
||||
.section {
|
||||
margin-bottom: 2.5rem;
|
||||
}
|
||||
|
||||
.section h2 {
|
||||
font-size: 0.75rem;
|
||||
font-weight: 600;
|
||||
letter-spacing: 0.2em;
|
||||
text-transform: uppercase;
|
||||
color: var(--accent-dim);
|
||||
margin-bottom: 1rem;
|
||||
padding-bottom: 0.5rem;
|
||||
border-bottom: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.section p {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.section p strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
.section a {
|
||||
color: var(--accent);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.section a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* Diagram */
|
||||
.diagram {
|
||||
background: var(--surface);
|
||||
border: 1px solid var(--border);
|
||||
padding: 1.5rem;
|
||||
margin-bottom: 1.5rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--dim);
|
||||
overflow-x: auto;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
.diagram pre {
|
||||
background: none;
|
||||
border: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
font-size: 0.75rem;
|
||||
color: var(--dim);
|
||||
}
|
||||
|
||||
.diagram .agent-name { color: var(--accent); }
|
||||
.diagram .phase { color: var(--green); }
|
||||
.diagram .arrow { color: var(--accent-dim); }
|
||||
|
||||
/* Agent cards */
|
||||
.agents-grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
gap: 1px;
|
||||
background: var(--border);
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
.agent-card {
|
||||
background: var(--surface);
|
||||
padding: 1.2rem;
|
||||
}
|
||||
|
||||
.agent-card .name {
|
||||
font-size: 0.8rem;
|
||||
color: var(--accent);
|
||||
margin-bottom: 0.4rem;
|
||||
}
|
||||
|
||||
.agent-card .role {
|
||||
font-size: 0.75rem;
|
||||
color: var(--dim);
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.agent-card .role strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
.agent-card .trigger {
|
||||
font-size: 0.65rem;
|
||||
color: var(--accent-dim);
|
||||
margin-top: 0.4rem;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.1em;
|
||||
}
|
||||
|
||||
/* Phase table */
|
||||
.phase-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin-bottom: 1.5rem;
|
||||
font-size: 0.8rem;
|
||||
}
|
||||
|
||||
.phase-table th {
|
||||
text-align: left;
|
||||
color: var(--accent-dim);
|
||||
font-size: 0.65rem;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.1em;
|
||||
padding: 0.6rem 0.8rem;
|
||||
border-bottom: 1px solid var(--border);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.phase-table td {
|
||||
padding: 0.6rem 0.8rem;
|
||||
border-bottom: 1px solid var(--border);
|
||||
color: var(--dim);
|
||||
}
|
||||
|
||||
.phase-table td:first-child {
|
||||
color: var(--green);
|
||||
font-size: 0.75rem;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.phase-table tr:last-child td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* Concept boxes */
|
||||
.concept {
|
||||
background: var(--surface);
|
||||
border: 1px solid var(--border);
|
||||
padding: 1.5rem;
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
.concept .label {
|
||||
font-size: 0.7rem;
|
||||
color: var(--accent-dim);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.15em;
|
||||
margin-bottom: 0.75rem;
|
||||
}
|
||||
|
||||
.concept p {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
margin-bottom: 0.75rem;
|
||||
}
|
||||
|
||||
.concept p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.concept p strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
/* Principle blocks */
|
||||
.principles {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr;
|
||||
gap: 1px;
|
||||
background: var(--border);
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
.principle {
|
||||
background: var(--surface);
|
||||
padding: 1rem 1.2rem;
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
}
|
||||
|
||||
.principle .id {
|
||||
color: var(--accent-dim);
|
||||
font-size: 0.7rem;
|
||||
white-space: nowrap;
|
||||
padding-top: 0.1rem;
|
||||
}
|
||||
|
||||
.principle .text {
|
||||
font-size: 0.8rem;
|
||||
color: var(--dim);
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.principle .text strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
/* Footer */
|
||||
.footer {
|
||||
text-align: center;
|
||||
padding-top: 2rem;
|
||||
border-top: 1px solid var(--border);
|
||||
font-size: 0.7rem;
|
||||
color: var(--dim);
|
||||
}
|
||||
|
||||
.footer a {
|
||||
color: var(--accent-dim);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.footer a:hover { color: var(--accent); }
|
||||
|
||||
/* Mobile */
|
||||
@media (max-width: 600px) {
|
||||
.header h1 { font-size: 1.5rem; }
|
||||
.container { padding: 2rem 1rem; }
|
||||
.agents-grid { grid-template-columns: 1fr; }
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
|
||||
<div class="header">
|
||||
<h1>Architecture</h1>
|
||||
<div class="subtitle">how the factory works</div>
|
||||
<a class="back" href="/">← disinto.ai</a>
|
||||
</div>
|
||||
|
||||
<div class="doc-nav">
|
||||
<a href="/docs/quickstart">Quickstart</a>
|
||||
<a href="/docs/architecture" class="active">Architecture</a>
|
||||
<a href="/dashboard">Dashboard</a>
|
||||
</div>
|
||||
|
||||
<!-- The Loop -->
|
||||
<div class="section">
|
||||
<h2>The agent loop</h2>
|
||||
<p>Disinto runs a continuous loop: <strong>vision defines direction</strong>, agents derive work and execute it, results feed back into the next cycle.</p>
|
||||
<div class="diagram">
|
||||
<pre>
|
||||
<span class="agent-name">planner</span> reads VISION.md
|
||||
<span class="arrow">|</span>
|
||||
<span class="arrow">v</span>
|
||||
creates backlog issues
|
||||
<span class="arrow">|</span>
|
||||
<span class="arrow">v</span>
|
||||
<span class="agent-name">dev-agent</span> picks issue <span class="arrow">--></span> implements in worktree <span class="arrow">--></span> opens PR
|
||||
<span class="arrow">|</span>
|
||||
<span class="arrow">v</span>
|
||||
Woodpecker CI runs tests
|
||||
<span class="arrow">|</span>
|
||||
<span class="arrow">v</span>
|
||||
<span class="agent-name">review-agent</span> reviews PR <span class="arrow">--></span> approves or requests changes
|
||||
<span class="arrow">|</span> <span class="arrow">|</span>
|
||||
<span class="arrow">v</span> (approved) <span class="arrow">v</span> (changes requested)
|
||||
PR merges dev-agent addresses feedback
|
||||
<span class="arrow">|</span> <span class="arrow">|</span>
|
||||
<span class="arrow">v</span> <span class="arrow">+--></span> CI re-runs <span class="arrow">--></span> review again
|
||||
<span class="agent-name">planner</span> sees progress, plans next cycle
|
||||
</pre>
|
||||
</div>
|
||||
<p>Each project processes <strong>one issue at a time</strong>. No concurrent PRs, no merge conflicts, no context switching. The pipeline is deliberately sequential.</p>
|
||||
</div>
|
||||
|
||||
<!-- Eight Agents -->
|
||||
<div class="section">
|
||||
<h2>Eight agents</h2>
|
||||
<p>Each agent has a single responsibility. They communicate through git, the Codeberg API, and the filesystem.</p>
|
||||
<div class="agents-grid">
|
||||
<div class="agent-card">
|
||||
<div class="name">dev-agent</div>
|
||||
<div class="role">Picks up backlog issues, <strong>implements code</strong> in isolated git worktrees, opens PRs. Runs as a persistent tmux session.</div>
|
||||
<div class="trigger">Cron: every 5 min</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">review-agent</div>
|
||||
<div class="role"><strong>Reviews PRs</strong> against project conventions. Approves clean PRs, requests specific changes on others.</div>
|
||||
<div class="trigger">Cron: every 5 min</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">planner</div>
|
||||
<div class="role">Reads VISION.md and repo state. <strong>Creates issues</strong> for gaps between where the project is and where it should be.</div>
|
||||
<div class="trigger">Cron: weekly</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">gardener</div>
|
||||
<div class="role"><strong>Grooms the backlog.</strong> Closes duplicates, promotes tech-debt issues, ensures issues are well-structured.</div>
|
||||
<div class="trigger">Cron: every 6 hours</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">supervisor</div>
|
||||
<div class="role"><strong>Monitors factory health.</strong> Kills stale sessions, manages disk/memory, escalates persistent failures.</div>
|
||||
<div class="trigger">Cron: every 10 min</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">predictor</div>
|
||||
<div class="role">Detects <strong>infrastructure patterns</strong> — recurring failures, resource trends, emerging issues. Files predictions for triage.</div>
|
||||
<div class="trigger">Cron: daily</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">action-agent</div>
|
||||
<div class="role">Executes <strong>operational tasks</strong> defined as formulas — site deployments, data migrations, any multi-step procedure.</div>
|
||||
<div class="trigger">Cron: every 5 min</div>
|
||||
</div>
|
||||
<div class="agent-card">
|
||||
<div class="name">vault</div>
|
||||
<div class="role"><strong>Safety gate.</strong> Reviews dangerous actions before they execute. Auto-approves safe operations, escalates risky ones to a human.</div>
|
||||
<div class="trigger">Event-driven</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase Protocol -->
|
||||
<div class="section">
|
||||
<h2>Phase protocol</h2>
|
||||
<p>When the dev-agent runs in a persistent tmux session, it signals progress by writing to a <strong>phase file</strong>. The orchestrator watches this file and injects events (CI results, review feedback) back into the session.</p>
|
||||
<table class="phase-table">
|
||||
<tr>
|
||||
<th>Phase</th>
|
||||
<th>Meaning</th>
|
||||
<th>Next event</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>awaiting_ci</td>
|
||||
<td>PR pushed, waiting for CI</td>
|
||||
<td>Orchestrator injects CI result</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>awaiting_review</td>
|
||||
<td>CI passed, waiting for review</td>
|
||||
<td>Review-agent injects feedback</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>needs_human</td>
|
||||
<td>Blocked on a human decision</td>
|
||||
<td>Matrix notification sent</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>done</td>
|
||||
<td>PR merged, work complete</td>
|
||||
<td>Session cleaned up</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>failed</td>
|
||||
<td>Unrecoverable error</td>
|
||||
<td>Escalated to supervisor</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>Phase files live at <code>/tmp/dev-session-{project}-{issue}.phase</code>. The protocol is intentionally simple — a plain text file, one line, no daemons.</p>
|
||||
</div>
|
||||
|
||||
<!-- Vault -->
|
||||
<div class="section">
|
||||
<h2>Vault — quality gate</h2>
|
||||
<div class="concept">
|
||||
<div class="label">How it works</div>
|
||||
<p>The vault sits between agents and dangerous actions. Before an agent can execute a risky operation (force push, deploy, delete), the vault reviews the request.</p>
|
||||
<p><strong>Auto-approve</strong> — safe, well-understood operations pass through instantly. <strong>Escalate</strong> — risky or novel operations get sent to a human via Matrix. <strong>Reject</strong> — clearly unsafe actions are blocked.</p>
|
||||
<p>You define the boundaries. The vault enforces them. This is what lets you sleep while the factory runs.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Planner + Predictor -->
|
||||
<div class="section">
|
||||
<h2>Planner + predictor feedback cycle</h2>
|
||||
<div class="concept">
|
||||
<div class="label">Closing the loop</div>
|
||||
<p>The <strong>planner</strong> runs weekly. It compares the current state of the codebase against VISION.md and creates issues for anything missing. It also triages predictions filed by the predictor.</p>
|
||||
<p>The <strong>predictor</strong> runs daily. It analyzes CI logs, git history, and resource metrics to detect patterns — recurring test failures, disk usage trends, code churn hotspots. Predictions are filed as issues for the planner to triage.</p>
|
||||
<p>Together, they create a feedback cycle: <strong>the predictor observes, the planner directs, and the dev-agent executes.</strong></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Infrastructure -->
|
||||
<div class="section">
|
||||
<h2>Infrastructure</h2>
|
||||
<p>Disinto is deliberately minimal. No Kubernetes, no message queues, no microservices.</p>
|
||||
<div class="concept">
|
||||
<div class="label">Tech stack</div>
|
||||
<p><strong>Bash scripts</strong> — every agent is a shell script. No compiled binaries, no runtimes to install.</p>
|
||||
<p><strong>Claude CLI</strong> — AI is invoked via <code>claude -p</code> (one-shot) or <code>claude</code> (persistent tmux sessions).</p>
|
||||
<p><strong>Cron</strong> — agents are triggered by cron jobs, not a daemon. Pull-based, not push-based.</p>
|
||||
<p><strong>Codeberg + Woodpecker</strong> — git hosting and CI. All state lives in git and the issue tracker. No external databases.</p>
|
||||
<p><strong>Single VPS</strong> — runs on an 8 GB server. Flat cost, no scaling surprises.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Design Principles -->
|
||||
<div class="section">
|
||||
<h2>Design principles</h2>
|
||||
<div class="principles">
|
||||
<div class="principle">
|
||||
<div class="id">AD-001</div>
|
||||
<div class="text"><strong>Nervous system runs from cron, not action issues.</strong> Planner, predictor, gardener, supervisor run directly. They create work, they don't become work.</div>
|
||||
</div>
|
||||
<div class="principle">
|
||||
<div class="id">AD-002</div>
|
||||
<div class="text"><strong>Single-threaded pipeline per project.</strong> One dev issue at a time. No new work while a PR awaits CI or review.</div>
|
||||
</div>
|
||||
<div class="principle">
|
||||
<div class="id">AD-003</div>
|
||||
<div class="text"><strong>The runtime creates and destroys, the formula preserves.</strong> Runtime manages worktrees/sessions/temp. Formulas commit knowledge to git before signaling done.</div>
|
||||
</div>
|
||||
<div class="principle">
|
||||
<div class="id">AD-004</div>
|
||||
<div class="text"><strong>Event-driven > polling > fixed delays.</strong> Never hardcoded sleep. Use phase files, webhooks, or poll loops with backoff.</div>
|
||||
</div>
|
||||
<div class="principle">
|
||||
<div class="id">AD-005</div>
|
||||
<div class="text"><strong>Secrets via env var indirection, never in issue bodies.</strong> Issue bodies become code. Secrets go in <code>.env</code> or TOML project files.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Directory Layout -->
|
||||
<div class="section">
|
||||
<h2>Directory layout</h2>
|
||||
<div class="diagram">
|
||||
<pre>
|
||||
disinto/
|
||||
├── <span class="agent-name">dev/</span> dev-poll.sh, dev-agent.sh, phase-handler.sh
|
||||
├── <span class="agent-name">review/</span> review-poll.sh, review-pr.sh
|
||||
├── <span class="agent-name">gardener/</span> gardener-run.sh (cron executor)
|
||||
├── <span class="agent-name">predictor/</span> predictor-run.sh (daily cron executor)
|
||||
├── <span class="agent-name">planner/</span> planner-run.sh (weekly cron executor)
|
||||
├── <span class="agent-name">supervisor/</span> supervisor-run.sh (health monitoring)
|
||||
├── <span class="agent-name">vault/</span> vault-poll.sh, vault-agent.sh, vault-fire.sh
|
||||
├── <span class="agent-name">action/</span> action-poll.sh, action-agent.sh
|
||||
├── <span class="agent-name">lib/</span> env.sh, agent-session.sh, ci-helpers.sh
|
||||
├── <span class="agent-name">projects/</span> *.toml per-project config
|
||||
├── <span class="agent-name">formulas/</span> TOML specs for multi-step agent tasks
|
||||
├── <span class="agent-name">bin/</span> disinto CLI entry point
|
||||
└── <span class="agent-name">docs/</span> internal protocol docs
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
<a href="/">← disinto.ai</a> ·
|
||||
<a href="/docs/quickstart">Quickstart</a> ·
|
||||
<a href="https://codeberg.org/johba/disinto">Source</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
531
site/docs/quickstart.html
Normal file
531
site/docs/quickstart.html
Normal file
|
|
@ -0,0 +1,531 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Quickstart — Disinto</title>
|
||||
<meta name="description" content="Get from zero to your first automated PR in under 10 minutes. Prerequisites, disinto init walkthrough, and the full issue-to-merge lifecycle.">
|
||||
<link rel="icon" href="../favicon.ico" sizes="32x32">
|
||||
<link rel="icon" href="../favicon-192.png" sizes="192x192" type="image/png">
|
||||
<link rel="apple-touch-icon" href="../apple-touch-icon.png">
|
||||
<link rel="canonical" href="https://disinto.ai/docs/quickstart">
|
||||
<meta property="og:title" content="Quickstart — Disinto">
|
||||
<meta property="og:description" content="Get from zero to your first automated PR in under 10 minutes.">
|
||||
<meta property="og:url" content="https://disinto.ai/docs/quickstart">
|
||||
<meta property="og:type" content="article">
|
||||
<style>
|
||||
:root {
|
||||
--bg: #0a0a0a;
|
||||
--fg: #e0e0e0;
|
||||
--dim: #707070;
|
||||
--accent: #c8a46e;
|
||||
--accent-dim: #8a7044;
|
||||
--surface: #141414;
|
||||
--border: #222;
|
||||
--green: #4a7;
|
||||
}
|
||||
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
|
||||
body {
|
||||
font-family: 'SF Mono', 'Cascadia Code', 'Fira Code', 'JetBrains Mono', monospace;
|
||||
background: var(--bg);
|
||||
color: var(--fg);
|
||||
line-height: 1.7;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 720px;
|
||||
margin: 0 auto;
|
||||
padding: 3rem 2rem;
|
||||
}
|
||||
|
||||
/* Header */
|
||||
.header {
|
||||
text-align: center;
|
||||
margin-bottom: 3rem;
|
||||
}
|
||||
|
||||
.header h1 {
|
||||
font-size: 2rem;
|
||||
font-weight: 300;
|
||||
letter-spacing: 0.2em;
|
||||
text-transform: uppercase;
|
||||
color: var(--accent);
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.header .subtitle {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
letter-spacing: 0.1em;
|
||||
}
|
||||
|
||||
.header .back {
|
||||
display: inline-block;
|
||||
margin-top: 0.75rem;
|
||||
color: var(--accent-dim);
|
||||
text-decoration: none;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.header .back:hover { color: var(--accent); }
|
||||
|
||||
/* Navigation between docs */
|
||||
.doc-nav {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
gap: 1.5rem;
|
||||
margin-bottom: 2.5rem;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.doc-nav a {
|
||||
color: var(--accent-dim);
|
||||
text-decoration: none;
|
||||
padding: 0.3rem 0.8rem;
|
||||
border: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.doc-nav a:hover { border-color: var(--accent-dim); }
|
||||
|
||||
.doc-nav a.active {
|
||||
color: var(--accent);
|
||||
border-color: var(--accent-dim);
|
||||
}
|
||||
|
||||
/* Section */
|
||||
.section {
|
||||
margin-bottom: 2.5rem;
|
||||
}
|
||||
|
||||
.section h2 {
|
||||
font-size: 0.75rem;
|
||||
font-weight: 600;
|
||||
letter-spacing: 0.2em;
|
||||
text-transform: uppercase;
|
||||
color: var(--accent-dim);
|
||||
margin-bottom: 1rem;
|
||||
padding-bottom: 0.5rem;
|
||||
border-bottom: 1px solid var(--border);
|
||||
}
|
||||
|
||||
.section p {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.section p strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
.section ul, .section ol {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
margin-bottom: 1rem;
|
||||
padding-left: 1.5rem;
|
||||
}
|
||||
|
||||
.section li {
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.section li strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
.section a {
|
||||
color: var(--accent);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.section a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* Code blocks */
|
||||
pre {
|
||||
background: var(--surface);
|
||||
border: 1px solid var(--border);
|
||||
padding: 1.2rem 1.5rem;
|
||||
margin-bottom: 1rem;
|
||||
overflow-x: auto;
|
||||
font-size: 0.8rem;
|
||||
line-height: 1.6;
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: inherit;
|
||||
font-size: 0.85rem;
|
||||
color: var(--accent);
|
||||
}
|
||||
|
||||
pre code {
|
||||
color: var(--fg);
|
||||
font-size: inherit;
|
||||
}
|
||||
|
||||
.comment { color: var(--dim); }
|
||||
.output { color: var(--green); }
|
||||
|
||||
/* Step numbers */
|
||||
.step-num {
|
||||
display: inline-block;
|
||||
width: 1.6rem;
|
||||
height: 1.6rem;
|
||||
line-height: 1.6rem;
|
||||
text-align: center;
|
||||
background: var(--accent-dim);
|
||||
color: var(--bg);
|
||||
font-size: 0.75rem;
|
||||
font-weight: 600;
|
||||
margin-right: 0.5rem;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.step-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
margin-bottom: 1rem;
|
||||
color: var(--fg);
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
|
||||
/* Prerequisites box */
|
||||
.prereqs {
|
||||
background: var(--surface);
|
||||
border: 1px solid var(--border);
|
||||
padding: 1.5rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
|
||||
.prereqs .label {
|
||||
font-size: 0.7rem;
|
||||
color: var(--accent-dim);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.15em;
|
||||
margin-bottom: 0.75rem;
|
||||
}
|
||||
|
||||
.prereqs ul {
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.prereqs li {
|
||||
color: var(--dim);
|
||||
font-size: 0.85rem;
|
||||
margin-bottom: 0.4rem;
|
||||
padding-left: 1.2rem;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.prereqs li::before {
|
||||
content: "\2610";
|
||||
position: absolute;
|
||||
left: 0;
|
||||
color: var(--accent-dim);
|
||||
}
|
||||
|
||||
.prereqs li strong {
|
||||
color: var(--fg);
|
||||
}
|
||||
|
||||
/* Expected output */
|
||||
.expected {
|
||||
background: var(--surface);
|
||||
border-left: 3px solid var(--green);
|
||||
padding: 1rem 1.5rem;
|
||||
margin-bottom: 1rem;
|
||||
font-size: 0.8rem;
|
||||
color: var(--dim);
|
||||
}
|
||||
|
||||
.expected .label {
|
||||
font-size: 0.65rem;
|
||||
color: var(--green);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.15em;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.expected code {
|
||||
color: var(--fg);
|
||||
font-size: 0.8rem;
|
||||
}
|
||||
|
||||
/* Lifecycle diagram */
|
||||
.lifecycle {
|
||||
background: var(--surface);
|
||||
border: 1px solid var(--border);
|
||||
padding: 1.5rem;
|
||||
margin-bottom: 1.5rem;
|
||||
font-size: 0.8rem;
|
||||
color: var(--dim);
|
||||
text-align: center;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.lifecycle .step {
|
||||
color: var(--accent);
|
||||
}
|
||||
|
||||
.lifecycle .arrow {
|
||||
color: var(--border);
|
||||
margin: 0 0.3rem;
|
||||
}
|
||||
|
||||
.lifecycle .agent {
|
||||
color: var(--dim);
|
||||
font-size: 0.65rem;
|
||||
display: block;
|
||||
margin-top: 0.3rem;
|
||||
}
|
||||
|
||||
/* Footer */
|
||||
.footer {
|
||||
text-align: center;
|
||||
padding-top: 2rem;
|
||||
border-top: 1px solid var(--border);
|
||||
font-size: 0.7rem;
|
||||
color: var(--dim);
|
||||
}
|
||||
|
||||
.footer a {
|
||||
color: var(--accent-dim);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.footer a:hover { color: var(--accent); }
|
||||
|
||||
/* Mobile */
|
||||
@media (max-width: 600px) {
|
||||
.header h1 { font-size: 1.5rem; }
|
||||
.container { padding: 2rem 1rem; }
|
||||
pre { padding: 1rem; font-size: 0.75rem; }
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
|
||||
<div class="header">
|
||||
<h1>Quickstart</h1>
|
||||
<div class="subtitle">from zero to your first automated PR</div>
|
||||
<a class="back" href="/">← disinto.ai</a>
|
||||
</div>
|
||||
|
||||
<div class="doc-nav">
|
||||
<a href="/docs/quickstart" class="active">Quickstart</a>
|
||||
<a href="/docs/architecture">Architecture</a>
|
||||
<a href="/dashboard">Dashboard</a>
|
||||
</div>
|
||||
|
||||
<div class="prereqs">
|
||||
<div class="label">Prerequisites</div>
|
||||
<ul>
|
||||
<li><strong>A VPS or server</strong> — 8 GB RAM minimum (Ubuntu/Debian recommended)</li>
|
||||
<li><strong>A Codeberg account</strong> — with a repo and at least one issue</li>
|
||||
<li><strong>A second Codeberg account</strong> — for the review bot (branch protection requires a different reviewer)</li>
|
||||
<li><strong>Woodpecker CI</strong> — running and connected to your repo</li>
|
||||
<li><strong>An Anthropic API key</strong> — with the <code>claude</code> CLI installed and authenticated</li>
|
||||
<li><strong>tmux</strong> — for persistent dev sessions</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<!-- Step 1: Clone disinto -->
|
||||
<div class="section">
|
||||
<div class="step-header">
|
||||
<span class="step-num">1</span>
|
||||
Clone the factory
|
||||
</div>
|
||||
<p>Clone disinto onto your server. This is the factory — the code that runs your agents.</p>
|
||||
<pre><code>git clone https://codeberg.org/johba/disinto.git ~/disinto
|
||||
cd ~/disinto
|
||||
cp .env.example .env</code></pre>
|
||||
<p>Edit <code>.env</code> with your tokens:</p>
|
||||
<pre><code><span class="comment"># Required</span>
|
||||
CODEBERG_TOKEN=your_codeberg_token
|
||||
REVIEW_BOT_TOKEN=your_review_bot_token
|
||||
|
||||
<span class="comment"># Woodpecker CI</span>
|
||||
WOODPECKER_TOKEN=your_woodpecker_token
|
||||
WOODPECKER_SERVER=http://localhost:8000
|
||||
|
||||
<span class="comment"># Timeouts</span>
|
||||
CLAUDE_TIMEOUT=7200</code></pre>
|
||||
</div>
|
||||
|
||||
<!-- Step 2: Initialize your project -->
|
||||
<div class="section">
|
||||
<div class="step-header">
|
||||
<span class="step-num">2</span>
|
||||
Initialize your project
|
||||
</div>
|
||||
<p><code>disinto init</code> sets up everything: clones the repo, creates the project config, adds Codeberg labels, and installs cron jobs.</p>
|
||||
<pre><code>bin/disinto init https://codeberg.org/you/your-project</code></pre>
|
||||
<div class="expected">
|
||||
<div class="label">Expected output</div>
|
||||
<code>=== disinto init ===
|
||||
Project: you/your-project
|
||||
Name: your-project
|
||||
Cloning: https://codeberg.org/you/your-project.git -> /home/you/your-project
|
||||
Branch: main
|
||||
Created: /home/you/disinto/projects/your-project.toml
|
||||
Creating labels on you/your-project...
|
||||
+ backlog
|
||||
+ in-progress
|
||||
+ blocked
|
||||
+ tech-debt
|
||||
+ underspecified
|
||||
+ vision
|
||||
+ action
|
||||
Created: /home/you/your-project/VISION.md
|
||||
Cron entries installed
|
||||
Done. Project your-project is ready.</code>
|
||||
</div>
|
||||
<p>Optional flags:</p>
|
||||
<ul>
|
||||
<li><code>--branch main</code> — set the primary branch (auto-detected by default)</li>
|
||||
<li><code>--ci-id 3</code> — Woodpecker CI repo ID (0 = no CI)</li>
|
||||
<li><code>--repo-root /path/to/clone</code> — custom clone location</li>
|
||||
<li><code>--yes</code> — skip confirmation prompts</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<!-- Step 3: Prepare the repo -->
|
||||
<div class="section">
|
||||
<div class="step-header">
|
||||
<span class="step-num">3</span>
|
||||
Prepare your repo
|
||||
</div>
|
||||
<p>Your project needs three things before agents can work on it:</p>
|
||||
<ol>
|
||||
<li><strong>A CI pipeline</strong> — at least one <code>.woodpecker/*.yml</code> file. Agents wait for CI before reviewing or merging.</li>
|
||||
<li><strong>A CLAUDE.md</strong> — project context that agents read before every task. Describe your tech stack, how to build/test, coding conventions, and directory layout.</li>
|
||||
<li><strong>Branch protection</strong> — on Codeberg, require PR reviews and add the review bot as a write collaborator.</li>
|
||||
</ol>
|
||||
<pre><code><span class="comment"># Create CLAUDE.md in your project</span>
|
||||
cat > ~/your-project/CLAUDE.md <<'EOF'
|
||||
# Your Project
|
||||
|
||||
## Tech stack
|
||||
- Node.js, React, PostgreSQL
|
||||
|
||||
## How to build and test
|
||||
npm install && npm test
|
||||
|
||||
## Conventions
|
||||
- Use TypeScript, ESLint, Prettier
|
||||
- Tests in __tests__/ directories
|
||||
EOF
|
||||
|
||||
cd ~/your-project
|
||||
git add CLAUDE.md && git commit -m "Add CLAUDE.md for agent context"
|
||||
git push</code></pre>
|
||||
</div>
|
||||
|
||||
<!-- Step 4: File your first issue -->
|
||||
<div class="section">
|
||||
<div class="step-header">
|
||||
<span class="step-num">4</span>
|
||||
File your first issue
|
||||
</div>
|
||||
<p>Create an issue on Codeberg with the <code>backlog</code> label. Be specific — the dev-agent works best with clear acceptance criteria.</p>
|
||||
<pre><code><span class="comment"># Title: Add health check endpoint</span>
|
||||
<span class="comment"># Label: backlog</span>
|
||||
<span class="comment"># Body:</span>
|
||||
|
||||
## Problem
|
||||
The app has no health check endpoint for monitoring.
|
||||
|
||||
## Approach
|
||||
Add a GET /health route that returns { "status": "ok" }.
|
||||
|
||||
## Acceptance criteria
|
||||
- [ ] GET /health returns 200 with JSON body
|
||||
- [ ] Response includes uptime in seconds
|
||||
- [ ] Test covers the new endpoint</code></pre>
|
||||
<p>That's it. The factory takes over from here.</p>
|
||||
</div>
|
||||
|
||||
<!-- Step 5: Watch the lifecycle -->
|
||||
<div class="section">
|
||||
<div class="step-header">
|
||||
<span class="step-num">5</span>
|
||||
Watch the lifecycle
|
||||
</div>
|
||||
<p>Within minutes, the agents start working. Here's what happens:</p>
|
||||
<div class="lifecycle">
|
||||
<span class="step">issue filed</span>
|
||||
<span class="arrow">→</span>
|
||||
<span class="step">dev-agent picks it up</span>
|
||||
<span class="arrow">→</span>
|
||||
<span class="step">PR opened</span>
|
||||
<span class="arrow">→</span>
|
||||
<span class="step">CI runs</span>
|
||||
<span class="arrow">→</span>
|
||||
<span class="step">review-agent reviews</span>
|
||||
<span class="arrow">→</span>
|
||||
<span class="step">merged</span>
|
||||
</div>
|
||||
<p>Monitor progress with:</p>
|
||||
<pre><code><span class="comment"># Check factory status</span>
|
||||
bin/disinto status
|
||||
|
||||
<span class="comment"># Watch the dev-agent log</span>
|
||||
tail -f /tmp/dev-agent.log
|
||||
|
||||
<span class="comment"># Watch the review log</span>
|
||||
tail -f /tmp/review.log</code></pre>
|
||||
<div class="expected">
|
||||
<div class="label">Expected timeline</div>
|
||||
<code>~2 min dev-poll finds the issue, claims it
|
||||
~5 min dev-agent opens a PR with the implementation
|
||||
~2 min CI runs (Woodpecker)
|
||||
~2 min review-agent approves or requests changes
|
||||
~1 min PR merges, issue closes automatically</code>
|
||||
</div>
|
||||
<p>If the review-agent requests changes, the dev-agent addresses them automatically. The loop repeats until the PR is approved and merged.</p>
|
||||
</div>
|
||||
|
||||
<!-- Step 6: Verify -->
|
||||
<div class="section">
|
||||
<div class="step-header">
|
||||
<span class="step-num">6</span>
|
||||
Verify everything works
|
||||
</div>
|
||||
<pre><code><span class="comment"># Factory status — shows active sessions, backlog depth, open PRs</span>
|
||||
bin/disinto status
|
||||
|
||||
<span class="comment"># Check your repo — the PR should be merged</span>
|
||||
cd ~/your-project
|
||||
git pull
|
||||
git log --oneline -5</code></pre>
|
||||
<p>You should see a merge commit with the dev-agent's implementation. The issue is closed, the branch is deleted.</p>
|
||||
</div>
|
||||
|
||||
<!-- What's next -->
|
||||
<div class="section">
|
||||
<h2>What's next</h2>
|
||||
<p>Now that the factory is running:</p>
|
||||
<ul>
|
||||
<li><strong>Write VISION.md</strong> — describe where the project is headed. The planner reads it weekly and creates issues to close gaps.</li>
|
||||
<li><strong>File more issues</strong> — the dev-agent processes them one at a time, in order. Use <code>## Dependencies</code> sections to control sequencing.</li>
|
||||
<li><strong>Watch the dashboard</strong> — <a href="/dashboard">disinto.ai/dashboard</a> shows live factory metrics.</li>
|
||||
<li><strong>Read the architecture</strong> — <a href="/docs/architecture">understand how the agents work together</a>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
<a href="/">← disinto.ai</a> ·
|
||||
<a href="/docs/architecture">Architecture</a> ·
|
||||
<a href="https://codeberg.org/johba/disinto">Source</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue