Skip to content

docs(D1): rewrite README pair for pre-launch#50

Merged
Li-Sanze merged 8 commits into
mainfrom
plan/20260529-pre-launch-consolidation
May 30, 2026
Merged

docs(D1): rewrite README pair for pre-launch#50
Li-Sanze merged 8 commits into
mainfrom
plan/20260529-pre-launch-consolidation

Conversation

@Li-Sanze
Copy link
Copy Markdown
Collaborator

Summary

Rewrites both README.md and README.zh-CN.md for external-facing pre-launch quality.

Key changes

  • Tagline: "AI coding that asks before it acts" / "先问再写、随时恢复的 AI 编程"
  • Design principles: 3-bullet philosophy section anchoring positioning
  • Why section: 3 story-driven scenarios (plan-first / teammate-handoff / decision-trace) replacing abstract gap/answer table
  • Demo SVG: Animated terminal showing real Sopify dogfooding (project=sopify, task=Copilot trigger wiring)
  • Scene images (zh-CN only): 3 hand-drawn illustrations (187-367KB JPGs)
  • Architecture: Simplified 3-layer SVG + stronger one-sentence description
  • Installation: Simplified to audit-first + table of 3 hosts
  • Removed: FAQ section, verbose setup paths, bootstrap.sh alias mention
  • Language polish: 13 edits across EN (6) + ZH (7)

Assets added/replaced

File Size Purpose
assets/demo-en.svg 14KB Animated demo (Claude→Codex cross-host)
assets/sopify-architecture.svg replaced Simplified 3-layer diagram
assets/sopify-cover-cn.jpg 207KB Hand-drawn cover (compressed from 1.6MB)
assets/readme-visuals/sopify-scene-ask.jpg 187KB Story 1: plan-first flow
assets/readme-visuals/sopify-scene-cross-host.jpg 210KB Story 2: teammate handoff
assets/readme-visuals/sopify-scene-decision.jpg 367KB Story 3: decision trace

Not included (follow-up)

  • 4.7/4.8: docs/how-sopify-works image upgrade (JPG→SVG)
  • Orphan cleanup: sopify-architecture-cn.jpg, logo.svg reference

Commits in this PR

02861f2 chore(D5-3B): pre-launch security cleanup
a7b32e0 feat(D3): converge ~go exec into ~go with auto-detection
0943bcf docs: consolidate CHANGELOG entries for D5-3B + D3
ada71cf chore(D5-3C): pre-launch doc/script cleanup
9c94469 docs: rewrite README pair for pre-launch

Li-Sanze added 8 commits May 29, 2026 13:16
Standard-level plan for pre-launch consolidation covering 7 directions:
- D2: Output enhancement system (rule-driven, not template piling)
- D3: Command surface convergence (~go exec removal)
- D5: Engineering audit fixes (17 items, 4 blocking)
- D1: README rewrite + visual asset upgrade
- D4: First-touch UX optimization
- D6: Promotional content matrix
- D7: Runtime Phase 2 shrink (design only)

Wave strategy:
- Wave 1 (D2+D3+D5): Internal cleanup, no README
- Wave 2 (D1+D4): README full rewrite + first-touch
- Wave 3 (D6): Promotional content
- Wave 4 (D7): Runtime design only

Includes 2 SVG architecture diagrams and competitive analysis.
- .gitignore: add .env, .venv/, dist/, build/, .claude/settings.local.json, .agents/history/, reports/
- git rm --cached .claude/settings.local.json (untrack local config)
- bootstrap_workspace.py: remove ~summary residual regex from blocked patterns
- bootstrap.sh: remove dead init parameter handling
Remove ~go exec as a user-facing command. Bare ~go now auto-detects
active plans and routes to exec_plan internally. Typing the old
~go exec command returns a migration hint instead of silently entering
a workflow with body 'exec'.

Key changes:
- router.py: remove ~go exec pattern, add snapshot-based active plan
  detection on bare ~go, add ~go finalize explicit route, add ~go exec
  migration hint
- entry_guard.py: empty bypass blocked commands (no more ~go exec)
- output.py: update exec_handoff / next_exec messages (zh-CN + en-US)
- clarification.py: update bodyless command set
- develop SKILL.md: activation condition reflects ~go auto-routing
- header templates / README / blueprint: remove ~go exec from docs
- 658 tests pass, including new migration hint test

Context-Checkpoint: B
- docs: remove ghost path .github/instructions/sopify.instructions.md
  (actual install target is .github/copilot-instructions.md)
- install.sh: add python3 → python → py -3 fallback chain (align with install.ps1)
- tests: delete ~compare dead tests (command removed, 656 tests pass)
- tasks.md: mark 3.11/3.12/3.15 done, skip 3.14 (script exists)
- Rewrite both EN and zh-CN READMEs (tagline, stories, install)
- Add animated SVG demo (Claude Code + Codex CLI scenes)
- Redesign architecture SVG (3 real hosts + skill workflow layer)
- Generate new EN/CN cover images (notebook metaphor)
- Add 3 scene images for zh-CN stories
- Remove logo from README headers, shrink cover to 660px
- Remove obsolete sopify-architecture-cn.jpg
- Polish language: 13 micro-edits from independent review
- Update header.md.template copyright lines
Release-Sync: yes

Release-Version: 2026-05-30.193318

Release-Date: 2026-05-30
…26-05-30.193318

The previous regen commit (7ed1cc5) bumped templates but the snapshot
file in that commit retained the old hashes, causing CI to fail. This
commits the actually-regenerated hashes.
@Li-Sanze Li-Sanze merged commit d24aed5 into main May 30, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant