Conversation
The README's 'Why whittle?' quick-link landed on a compression-only essay, a bait-and-switch for anyone clicking to understand the product. The doc now opens as Why whittle: two short paragraphs, one per surface (why compress tool outputs at write time; why route requests per an auditable policy), with the original write-time-vs-read-time essay preserved beneath as 'The write-time argument'. Links updated; no dangling references. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Technical-writer audit of the reader path (README -> policies/default.md -> ROUTER.md) found it explains the shipped default but cannot teach a new user to author a policy: no per-leaf JSON shapes, no signal-definition syntax or the 14 category strings, no tuning workflow, no inspect/session/keep semantics, no validation-error reference, no log-debugging vocabulary. docs/POLICY.md fills it, task-oriented: ten-line mental model, the minimum valid policy, the condition grammar (including the rules that bite: no implicit AND, single-node not, depth cap), a complete leaf reference with exact JSON and matching semantics, signal definitions with a probe-the-sidecar tuning workflow, inspect scopes and the keyword-vs-ML text asymmetry, stickiness and the pin header, the init -> validate -> SIGHUP -> log authoring loop, the full signals trace vocabulary, seven recipe policies, and symptom->fix + validation-message reference tables. All 8 complete example policies pass the real loader (independently re-verified). Zero em-dashes. Drift fixed along the way: ROUTER.md section 8's log example was missing the signals field the router actually emits. README and default.md now link the guide; ROUTER.md stays the architecture reference and cross-links it. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Two documentation improvements from founder review:
docs/why-whittle.md (was why-write-time.md): the README's "Why whittle?" link landed on a compression-only essay. Now opens with two short paragraphs, one per surface (why compress at write time, why route per an auditable policy), with the write-time-vs-read-time essay preserved beneath as a section.
Policy authoring guide (incoming on this PR): a technical-writer audit of the policy customization docs found they don't teach a new user to author a policy; a dedicated task-oriented guide is being added, with every JSON example validated against the real loader.
🤖 Generated with Claude Code