Skip to content

Add "How it works" overview section to README#47

Merged
yavorpanayotov merged 1 commit into
mainfrom
docs/how-it-works-overview
Jun 19, 2026
Merged

Add "How it works" overview section to README#47
yavorpanayotov merged 1 commit into
mainfrom
docs/how-it-works-overview

Conversation

@yavorpanayotov

Copy link
Copy Markdown
Collaborator

What

Adds a How it works section to the README, placed right after "What this is" and before the install instructions, so readers get the mental model before they're told how to install.

It introduces:

  • the spec-as-primary-artefact framing and the when/requires/ensures shape of a rule;
  • an ASCII diagram of the loop — /elicit and /distill feeding the spec from two directions, /tend and /weed maintaining it, /propagate flowing out to tests;
  • a short paragraph tying each skill to its role, linking to the existing skills table rather than duplicating it.

Why

The README jumped straight from "what this is" to "get started" with no high-level picture of how the pieces fit together. This gives a first-time reader the workflow at a glance.

🤖 Generated with Claude Code

Introduce the spec-as-primary-artefact mental model and the
elicit/distill -> tend/weed -> propagate loop, with an ASCII diagram,
before the install instructions. Links to the existing skills table
rather than duplicating it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@yavorpanayotov yavorpanayotov merged commit 916eafa into main Jun 19, 2026
1 check passed
@yavorpanayotov yavorpanayotov deleted the docs/how-it-works-overview branch June 19, 2026 11:11
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