Skip to content

docs: open the README with what the gate caught on this repo's own PRs - #16

Draft
lucasheriques wants to merge 1 commit into
mainfrom
readme-opening
Draft

lucasheriques wants to merge 1 commit into
mainfrom
readme-opening

Conversation

@lucasheriques

Copy link
Copy Markdown
Owner

Why

The README opens with provenance and install, so a first-time visitor never sees what the plugin does.

What changed

A "What it looks like" section before Install. It tells the billing-glob story from #14, then describes the playbook, review gate, and merge-gate loop in plain words.

Scope

Draft until Lucas reads it. The first-person story and the framing are his to approve before this ships and gets posted.

Verification

  • bun scripts/check-port.ts: 0 findings.
  • 23 playbooks in skills/poteto-mode/playbooks, matching the README's count.

Adds a What it looks like section before Install: the billing-glob miss the interrogate gate found in the example merge policy, then a plain description of the playbook, review gate, and merge-gate loop.

Tested: bun scripts/check-port.ts (0 findings); playbook count (23) checked against skills/poteto-mode/playbooks; billing-glob story re-read against PR 14's commits.
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