You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Covers sync workflows: manual sync, importing issues, and sync-on-push
behavior. Also adds anchor ID to config page for cross-linking.
Co-Authored-By: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/src/pages/guide.astro
+69Lines changed: 69 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -265,6 +265,75 @@ All 24 tests passing."</pre>
265
265
<spanclass="cli-yellow">[ ]</span> <spanclass="cli-bold">def456</span> <spanclass="cli-red">[B: abc123]</span>: Deploy to production</pre>
266
266
</Terminal>
267
267
268
+
<h2>Syncing with GitHub</h2>
269
+
270
+
<p>Dex can sync tasks to GitHub Issues, giving your team visibility into AI-assisted work without requiring everyone to use Claude Code.</p>
271
+
272
+
<h3>Why Sync?</h3>
273
+
274
+
<ul>
275
+
<li>Share progress with team members who don't use Claude Code</li>
276
+
<li>Create a paper trail for completed work</li>
277
+
<li>Get GitHub's notification system for task updates</li>
278
+
<li>Back up task context outside your local machine</li>
279
+
</ul>
280
+
281
+
<h3>Enabling Sync</h3>
282
+
283
+
<p>Configure your repository in <ahref="/config#github-sync">config</a>. Dex authenticates via the <code>gh</code> CLI or <code>GITHUB_TOKEN</code> environment variable.</p>
<p>Use <code>--all</code> to import all open issues at once.</p>
312
+
313
+
<h3>Sync-on-Push</h3>
314
+
315
+
<p>Completed tasks only close their GitHub Issues when the completion has been pushed to the remote. This prevents issues from closing before the actual code lands.</p>
316
+
317
+
<pclass="example-label">Why this matters:</p>
318
+
<blockquote>
319
+
You complete a task locally, but your branch isn't merged yet. Without sync-on-push, the issue would close immediately—confusing teammates who see a "closed" issue with no merged PR. With sync-on-push, the issue stays open until your work is actually in the repository.
Synced 1 task(s) <spanclass="cli-dim">(issue now closed)</span></pre>
333
+
</Terminal>
334
+
335
+
<p><strong>Note:</strong> If <code>.dex/</code> is in your <code>.gitignore</code>, sync-on-push detection is disabled since dex can't determine push status.</p>
336
+
268
337
<h2>Important: Tasks are Ephemeral</h2>
269
338
270
339
<p>Dex tasks are coordination tools, not permanent records. <strong>Never put task IDs in:</strong></p>
0 commit comments