docs: rewrite README.md for its actual reader, the model - #12
Merged
Merged
Conversation
The container's `recipe_show` returns this file verbatim to Butler beside the params schema, and it is the last thing read before a duty is filed from this template. The previous version was a GitHub landing page — a repo-name title, an install-shaped 'How it is used' line, and a settings table restating recipe.json. None of that prose aids discovery either: recipe_search scores name, keywords, description and triggers, and never README text. So it now answers the two questions the model actually has — does this fit what my owner asked, and what goes in params — and leads with what the template will NOT do, which is the failure nobody notices: no price check, no second buy per slot, no selling, and nothing at all before the owner funds the pocket. Each setting names its unit, because a bare number from an owner is dollars or a count depending on which one. 2179 bytes, under the registry's 4 KB warn threshold. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README.mdin a template bundle is not documentation for a human browsing GitHub. The container'srecipe_showreturns it verbatim to Butler, beside the params schema and the triggers, and it is the last thing read before a duty is filed from this template.The version that just merged was a landing page: a repo-name title, an install-shaped "How it is used" line, and a settings table restating
recipe.json. None of that prose aids discovery either —recipe_searchscoresname,keywords,descriptionandtriggers, and never README text.What it says now
It answers the two questions the model actually has — does this fit what my owner asked, and what goes in
params— and leads with what the template will not do, which is the failure nobody notices:MAX_PER_DAY, counted in UTC days in the duty's own state and surviving a restartEach setting names its unit, because a bare number from an owner is dollars or a count depending on which one it lands in.
2179 bytes — under the registry's 4 KB warn threshold, and every byte is prefilled into a turn's context on each
recipe_show.Depends on
butler-skills#32, which makes the rule normative and adds the checks that enforce it. It also fixes a live bug that makes this repo's CI red regardless of this PR: the merged validator reads
re.compile(...)as the builtincompile()and refusesduty.pyoutright.Verified against that branch's validator:
OK.🤖 Generated with Claude Code