Repository navigation
Home
Published from
docs/README.mdat835522e. Edit the source in the repository, not this page.
Sanduq adds delivery processes to Spec Kit projects: QA, an application manual, pull requests, GitHub Project sync, diagrams, project memory and a live progress report. You can use one portable skill, a few extensions, or the managed Workflow that runs them all from one GitHub issue. Pick that adoption level first, then install. When each extension runs shows where each one fits in the lifecycle.
| Level | You get | Start here |
|---|---|---|
| 1. Skills only | One task, such as a diagram or a manual, in any supported host. No Spec Kit. | Skills only |
| 2. One extension | One process added to a Spec Kit project | One extension |
| 3. Pick your extensions | Several standalone processes, such as QA, docs and board sync, with no Workflow | Pick your extensions |
| 4. Managed Workflow | One GitHub issue taken to a verified pull request, resumable | Managed Workflow |
| Task | Page |
|---|---|
| See who Sanduq is for and how success is measured | Product brief |
| See when each extension runs and what sends work back | How it runs |
| Check the tools and versions you need | Prerequisites |
| Create or prepare a Spec Kit project | Set up Spec Kit |
| Install on Codex, Claude Code or Claude Desktop, and set recipes | Install by host |
| Fix a common problem | Troubleshooting |
| Upgrade, read changelogs, find moved pages | Upgrades |
Scope requires Workflow and Illustrate. Assure, PR and User Manual require Illustrate, and PR uses Assure and User Manual when they are installed. Project and Memory need no other extension. The portable skills come from sanduq-skills and are copied into the extensions. Editable source.
One page per extension: purpose, lifecycle phase, hooks, dependencies, setup, an example and limits.
| Job | Extension | Purpose |
|---|---|---|
| Managed delivery | Workflow | Resumable issue-to-PR dispatcher |
| Managed delivery | Scope | Issue scope, prerequisites and decomposition; part of Workflow from 2.0.0 |
| Checks and pull requests |
QA (assure) |
QA readiness analysis and tester walkthrough |
| Checks and pull requests |
Pull requests (pr) |
Feature docs, PR description and review feedback |
| Documentation | User Manual | Manuals for the audiences and languages you choose |
| Documentation | Illustrate | Themed diagrams and charts |
| Tracking and context |
Project sync (project) |
GitHub Project board sync |
| Tracking and context | Progress | Live, deterministic feature progress report |
| Tracking and context | Memory | Project memory and recoverable spec archiving |
| Task | Page |
|---|---|
| Follow a feature through every stage | Worked lifecycle |
| Resume, upgrade or recover | Operating guide |
| Inspect state, progress and runners | State, evidence and runners |
| Change QA or manual selection, or the CI gate | Delivery policy |
| Look up stages, state files, schemas, runner policy, utilities, delegation | Stages · State files · Schemas · Runner policy · Utilities · Delegation · Development |
| Page | Contents |
|---|---|
| Commands | All 42 commands with an example each, and host syntax |
| Hooks | Every hook: manifest defaults and the managed Workflow view (generated) |
| Error codes | What each Workflow error code means and the command to run next (generated) |
| Compatibility | Hosts, platforms, live-run evidence, tested versions and Spec Kit ranges |
| Licenses | License per package |
| Glossary | Terms used in these pages |
| Example | Page |
|---|---|
| Draw a process and choose preset or custom colors | Illustrate examples |
| Bound a debate, run parallel reviews, or automate delegation | Delegate Task examples |
| Compare real manual themes and install your own | User Manual theme gallery |
The examples describe a synthetic booking application with Booking, Payments, and Operations
modules. Its GitHub repository is example-org/booking-app; issue 412, titled Refund approval,
produces specs/412-refund-approval/. A customer requests a refund, an operator approves or rejects
it, and the payment provider returns the settlement result. Repeated approval must not settle twice.
Replace these identifiers with your own. Issue 412, task T012, PR 438, and release tags v2.4.0
and v3.0.0 illustrate different identities; they are not live Sanduq records or promised
application behavior. Read your real API contract and tests before documenting the application.
Prompts use Claude Code /… syntax; Codex uses $ instead of /. See command names for other hosts.
Shell commands run in the consumer repository unless a step says Sanduq checkout.
Replace angle-bracket placeholders before execution. Screenshots and payloads use synthetic data.
| Task | Page |
|---|---|
| Find the owning source, test packages and submit a change | Contributing |
| Write or edit these pages | Style guide |
| Ship a release train | Release process |
| Find logos and editable illustrations | Asset index |
| Look up an exact package contract | Extension source index |