Skip to content

v1.1.0 — README redesign & quick-start visuals

Latest
Latest

Choose a tag to compare

View all tags
@nxl801 nxl801 released this 23 Jul 13:19
v1.1.0
48d7f87

v1.1.0 — README redesign & quick-start visuals

A documentation-only release. No code, schemas, or behavior changed since
v1.0.0 — the Meta-Skill regression suite still reports 121 passed. This
release polishes the project's front door: a fully restructured bilingual README
and three custom-generated quick-start diagrams.

SemVer: minor bump. The change set is documentation and assets only, with no
breaking changes and no new code surface — a minor version signals a visible,
user-facing improvement to the project's presentation.

What changed

README — full restructure (EN + 简体中文, 1:1 mirror)

The previous README had grown by accretion to 22 sections / 638 lines, and the
reliability section at the end read as a labeled patch rather than an integrated
part of the project. Both READMEs were rewritten from scratch:

  • Leaner narrative — 638 → 399 lines (EN), 593 → 400 lines (ZH), modeled on
    the structure of trending open-source READMEs (hero → why → quick-start-up-front
    → how-it-works → features).
  • Human usage front-loaded — a 3-step guide (Prepare → Run → Review) now sits
    right at the top of Quick Start, with an ASCII-free visual and a plain-language
    "what happens behind the scenes" explanation.
  • Reliability, integrated natively — the multi-judge review, dry-run gate,
    cross-process crash recovery, and tamper-evident audit are now woven into the
    How It Works section as built-in guarantees, with no internal jargon
    (T3 / T4 / WP-13) leaking into the reader-facing flow.
  • Deep dives collapsed — repository layout and key-docs tables moved into
    collapsible <details> blocks; the slide-walkthrough meta-section was removed
    in favor of a link to the deck.

Quick Start — three new diagrams (Grok-generated)

The three ASCII-art boxes in Quick Start were replaced with real flat-vector
infographics, generated via the Grok CLI and color-matched to the existing
22 sanitized deck images (emerald #10B981 / #059669 + slate #6B7280 +
white) so the new art does not clash with the established visual identity.

Image Replaces Shows
qs1-3step-flow.png 3-step ASCII logic diagram PREPARE → RUN → REVIEW (middle highlighted)
qs2-prepare-task.png (new, above the directory tree) SKILL + USAGE SET + CONFIG → TASK
qs3-behind-scenes.png linear behind-the-scenes arrow diagram RUNNER → EVAL → DIAG → OPTIMIZE closed loop, with a blind-wall/lock isolation visual

Design choices:

  • Language-neutral — art carries only short English labels; long-form
    explanation and the copyable directory tree stay in markdown/code blocks.
    One image set serves both locales, so there is no bilingual image maintenance.
  • Reproducible — the exact Grok prompts and the locked design spec are saved
    in docs/images/prompts/quickstart-style-spec.md; SVG sources for two of the
    three diagrams are kept alongside the PNGs for future tweaks.

Verification

Meta-Skill native regression
  121 passed

working tree
  clean, in sync with origin/main

code diff since v1.0.0
  0 .py files changed

Compatibility

Fully backward-compatible. No breaking changes. Nothing that consumed v1.0.0
needs to change for v1.1.0.

Full diff: v1.0.0...v1.1.0

Assets 2
Loading