Skip to content

docs: live site in plain language, for readers who do not code - #18

Merged
cskwork merged 1 commit into
mainfrom
docs/plain-language-site
Oct 3, 2026
Merged

cskwork merged 1 commit into
mainfrom
docs/plain-language-site

Conversation

@cskwork

@cskwork cskwork commented Oct 3, 2026

Copy link
Copy Markdown
Owner

What

The GitHub Pages site (docs/index.html) is rewritten so that a reader who does not write code can follow it. That is the page's purpose; the v0.22.0 update made it current but left it written for developers.

  • No file names, commands, flags, or kit jargon in the story sections. A gate is a "checkpoint" (확인 지점); stages are named for what they do (Understand, Describe, Plan, Build, Deliver, Follow up); lazymode is "which checkpoints wait for a person".
  • The hero keeps its terminal frame but shows a plain exchange: the AI is ready, the checkpoint says a person has not approved yet, the person approves, the work goes on.
  • "What you get" has five entries (was eight). "What it cannot do" keeps the honest limit.
  • Commands and file names appear only in the last section, "For the person who sets it up" (설치하는 분께).
  • A comment at the top of the file records the audience rule.
  • English and Korean say the same things. 46.3 → 41.8 KB.

No kit file changed; no version bump.

Verified

  • HTML parses, tags balance, anchors and local links resolve; the page script passes node --check.
  • 68 text keys in the page, 68 in the Korean table, none missing or unused.
  • A scan of the visible text before the install section finds none of the listed technical terms in either language.
  • Rendered in headless Chrome in both languages; both sets of copy read in full.

Not verified

  • No reader outside the project has read it.

The site's purpose is that anyone can understand it. The page copy no longer
uses file names, commands, or terms such as gate, artifact, adversary,
harness, or lazymode: a gate is a checkpoint, each stage is named for what
it does, and the hero terminal shows a plain exchange where a checkpoint
stops the AI until a person approves. Commands and file names appear only
in the last section, labelled for the person who sets the kit up. English
and Korean say the same things; 46.3 → 41.8 KB.

A comment at the top of the file records the audience rule for the next
editor.
@cskwork
cskwork merged commit 3024c60 into main Oct 3, 2026
3 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.

2 participants