docs: README rewrite, protocol doc, open-questions#2
Open
mirkokiefer wants to merge 3 commits into
Open
Conversation
Repositions the README around builder pain (state-mutation drift) before introducing vocabulary. Pulls the philosophical thesis out of the README into a dedicated PROTOCOL.md; surfaces unsolved problems as collaboration invitations in docs/open-questions.md. README changes: - New tagline: "Trace your agent's world, not just its tool calls." - Hero replaced: 60-second drift-caught story + 2-line drop-in code + sub-line about the CLI viewer. - New "Five words you'll meet" section teaches scene / diff / goal / gradient / predictor by example, not definition. Each term anchored in a concrete picture or sentence. - Five-tier ladder reframed: each tier leads with the dev pain it solves, not the framework feature it adds. Tier 4 in particular framed as "predict before commit for irreversible actions." - "Why this isn't another agent framework" trimmed to 3 rows; "What scenegrad does NOT do" cut entirely; "Thinking framework" prose relocated to PROTOCOL.md. - "Scenes are the unit of agent work" thesis section before the stack, three sentences, links to PROTOCOL.md and open-questions.md. - Stack section promoted from "Related" — scenecast first as the foundational vocabulary. PROTOCOL.md (new): - Five primitives (Scene, Assertion, Goal, Patch, ToolCall, Predictor) with TypeScript signatures and one-paragraph contracts. - Two derivations (distance, gradient) explained as functions of the primitives. - Trajectory wire format + WorldModelMetrics scoring surface. - Pointer to open-questions.md for unsolved frontier. docs/open-questions.md (new): - Seven open frontiers: distance functions, semantic diffs, predictor scoring, multi-actor gradients, scene design as craft, cold-start moat, adversarial scenes. - Framed as invitations to collaborate, with explicit "want to push back?" closing section.
d532846 to
51d0c7b
Compare
Increment 1 of the mark integration: scenegrad's Goal<S> is now a union of mark.Predicate (preferred, going forward) and the legacy AssertionGoal shape. distance() and checkAll() handle either; existing scenebench paths keep working unchanged. This unblocks downstream benches (arcbench, future SAPBench) that want to pass mark Predicates directly without wrapping them in scenegrad's Assertion<S> interface. Increments 2-4 (migrate scenebench's adapter to pass Predicates directly, delete Assertion<S>) follow when needed. Also: remove a hardcoded local path from scripts/record-demo.ts.
- Dep: file:../mark → file:../autocheck - Imports: `Predicate, evaluate` → `CheckExpr, runCheck` - isPredicate() → isCheckExpr(); describePredicate() → describeCheckExpr() - Goal<S> = CheckExpr | AssertionGoal<S> - Bridge: autocheck.pass → assertionState.satisfied / Assertion contract (scenegrad's downstream Assertion / AssertionState shapes unchanged) 8 scenegrad tests still green.
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
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.
Summary
Rewrites the README around builder pain first, vocabulary second, then ships the philosophical thesis as a separate
PROTOCOL.mdplus anopen-questions.mdcollaboration invite.The current README leads with framework abstractions (scenes, gradients, tiers) before earning the right to use those words. A landing builder bounces. This rewrite reverses the order: the bug-caught moment comes first, the 2-line drop-in is the immediate payoff, and only then does the doc teach the vocabulary — anchored in concrete pictures, not definitions.
What ships
README.mdrewritePROTOCOL.md.scenecastlisted first as the foundational vocabulary the rest of the stack uses.PROTOCOL.md(new)The protocol scenegrad runs on, as a doc separate from the implementation:
Scene,Assertion,Goal,Patch,ToolCall,Predictor) with TypeScript signatures and one-paragraph contracts.distance, gradient) explained as functions of the primitives.WorldModelMetricsscoring surface.The doc is meant to be the canonical reference future implementations target — other languages, other runtimes, learned components — not just one implementation's internals.
docs/open-questions.md(new)Seven open frontiers, framed as collaboration invitations:
Each section ends with explicit unsolved questions. Closes with "Want to push back?" — pointer to the issues tab.
Why this shape
The previous README treated readers as if they'd already absorbed Daslab's worldview. They hadn't. The new README earns the worldview by leading with a recognizable bug, paying off with a 2-line fix, and only then introducing the five words that name what the reader is already looking at.
The thesis — scenes are the unit of agent work — is preserved in full, but lives in
PROTOCOL.mdwhere readers who want depth can find it without forcing it on first-time visitors.Dependency
References tier 4 (
Predictor,DreamerSolver,evalWorldModel,examples/dreamer-inbox.ts) which lands in #1. Either:Either order works; flagging in case there's a preferred merge sequence.
Test plan
./PROTOCOL.md,./docs/open-questions.md) point at files that exist on this branch.