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
Public surface refresh + W0 version model hardening: README rewrite with new hero tagline ("Resumable AI coding — ask first, plans stay with the repo"), bilingual scene illustrations, product-form diagrams, architecture SVG update, installer fail-loud version handling, 4-state status/doctor classifier, and protocol check continuation semantics fix.
27
+
28
+
### Changed
29
+
30
+
-**README**: New hero tagline (EN/CN), "how it works" body paragraph (managed workflow scoping, git-tracked plans/receipts vs local resume pointers), host compatibility badges (Codex / Claude / Qoder / Copilot), `for-the-badge` style for all shields.
English · [简体中文](./README.zh-CN.md) · [Quick Start](#quick-start) · [Contributors](./CONTRIBUTORS.md)
13
18
14
19
</div>
15
20
16
21
<divalign="center">
17
-
<imgsrc="./assets/sopify-cover.jpg"width="660"alt="Sopify — AI coding that asks before it acts" />
22
+
<imgsrc="./assets/sopify-cover.jpg"width="660"alt="Sopify — Resumable AI coding, ask first, plans stay with the repo" />
18
23
</div>
19
24
20
25
---
21
26
22
-
AI coding tools are fast. But when they jump to code without understanding what's needed, speed becomes rework. Sopify is a development process protocol layer for AI coding — it turns plans, decisions, handoffs, and verification records into project assets, so work can stop, resume, and be traced.
27
+
AI coding tools are fast. But when they jump to code before the facts are clear, speed turns into rework. Sopify is a development process protocol layer for AI coding: in managed workflows, the host asks before coding when requirements are incomplete or a decision still needs you.
28
+
29
+
Sopify stores plans and verification receipts in `.sopify/` as project files tracked by git. Only the local resume pointers stay out of git. Open the same repo on another host, and it reads those files to continue from where the work stopped.
23
30
24
31
No new editor, no new CLI. Install into the host you already use — Codex, Claude, Qoder, or Copilot.
25
32
26
33
**Design principles:**
27
34
28
35
-**Stop when unsure** — score every requirement; ask before assuming
29
-
-**Resume from anywhere** — plans, decisions, and verification records are tracked in `.sopify/`; open the repo on any host and pick up where you left off
36
+
-**Resume from anywhere** — plansand verification receipts are tracked in `.sopify/`; open the repo on any host and pick up where you left off
30
37
-**Trace every decision** — plans, choices, and reviews persist in `.sopify/`
31
38
32
39
**What Sopify prevents:**
@@ -58,16 +65,28 @@ After install, use `~go` to start a managed workflow. See [Installation](#instal
58
65
**When requirements are unclear, it stops to plan first.**
59
66
You say "add a caching layer." Sopify doesn't start coding — it plans first: analyze, design, split into tasks, then save to `.sopify/plan/`. Only after you confirm the plan does it write code. Every line changed traces back to a decision.
60
67
68
+
<divalign="center">
69
+
<imgsrc="./assets/readme-visuals/sopify-scene-ask-en.jpg"width="720"alt="Plan first, code second — discuss, record, execute" />
70
+
</div>
71
+
61
72
**Your teammate picks up where you left off.**
62
73
You start a feature in Codex, finish the design, and implement two of four tasks. Next week your teammate opens the same repo in Claude, types `~go`. Sopify reads the checkpoint and continues from task 3 — no handoff doc, no re-explaining context.
A month later, someone asks why the cache key includes the user ID. The answer is in `.sopify/plan/` — the requirement that prompted the decision, the design that resolved it, the review that approved it.
66
81
67
-
## Architecture
82
+
<divalign="center">
83
+
<imgsrc="./assets/readme-visuals/sopify-scene-decision-en.jpg"width="720"alt="Every decision traced — auditable and reviewable" />
<imgsrc="./assets/sopify-product-form-release-en.svg"width="900"alt="Sopify Product Form — host executes, skill guides, assets preserved, any host resumes" />
71
90
</div>
72
91
73
92
The host LLM executes. Sopify preserves auditable development assets — plans, decisions, handoffs, and verification evidence — in `.sopify/`, accessible across sessions, hosts, and teammates.
@@ -79,6 +98,14 @@ How Sopify achieves stability and quality:
79
98
-**Resumes from where you stopped** — the host reads the current plan, picks up the last handoff, and checks what's already been verified before continuing
80
99
-**Runtime retired; workflow retained** — the analyze → design → develop → finalize workflow is unchanged; what changed is that rules live in files, not a runtime process
81
100
101
+
## Architecture Details
102
+
103
+
For readers who want the internal layering behind the product form, the technical structure is below.
0 commit comments