docs: rewrite READMEs as storytelling registry landing pages#94
Closed
brentrager wants to merge 1 commit into
Closed
docs: rewrite READMEs as storytelling registry landing pages#94brentrager wants to merge 1 commit into
brentrager wants to merge 1 commit into
Conversation
Elevate every README (root + Rust/TS/Python/Go/.NET package pages) from a feature list into a narrative: hook → one engine in five languages → observe→think→act → the permission gate + deny-policy that makes an agent safe to point at production → build → get started. - Each package page leads with an agent+tool quickstart in its own idiom (mock scripted to call the tool, then answer), verified against the real API. - Adds the headline permission system + deny-policy (AutoMode, circuit-breakers, declarative TOML rules + semantic predicates) to every features list and gives it a dedicated safety-story section with a language-native example (with_deny_policy in Rust, denyPolicy/permissionMode in TS/Py, WithDenyPolicy in Go/C#). - Refreshes the root polyglot table (language → package → registry), fixes the stale "Planned" statuses (TS/Python/.NET are at parity now) and inconsistent test-count claims. Docs only — no code changes. Registry readme-pointers already wired (Cargo readme, pyproject readme, csproj PackageReadmeFile+packed README; npm ships README by default). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: a702c5f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Author
|
Folded into #93 so the first lockstep release is a single 1.7.0 (avoids a stray second release). |
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.
Problem
The READMEs read as feature lists that under-sold the engine, marked the TypeScript/Python/.NET ports as "Planned" (they're at parity now), carried inconsistent test-count claims, and never mentioned the headline permission system + deny-policy that just landed across all five languages.
What changed
Every README — the root and each per-language registry landing page (crates.io, npm, PyPI, pkg.go.dev, nuget.org) — was rewritten to tell a story:
hook → one engine in five languages → observe→think→act → the permission gate + deny-policy that makes an agent safe to point at production → build → get started.
with_deny_policy(Rust),denyPolicy/permissionModeoptions (TS/Py),WithDenyPolicy(Go/C#).Honesty / accuracy
Every API snippet was checked against the real source (type + method names:
AutoMode,DenyPolicy::from_toml/FromToml/from_toml,with_predicate/WithPredicate,DenyPredicate,PermissionHook, mockpushToolCall/push_tool_call, tool shapes per language). Only shipped features are described. No product/vendor names.Registry wiring
Already present — no manifest edits needed: Rust
readme = "README.md", pyprojectreadme = "README.md", csproj<PackageReadmeFile>+ packed..\README.md; npm shipsREADME.mdby default regardless offiles.Docs only — no code changes. Changeset added (
@smooai/smooth-operator-corepatch).🤖 Generated with Claude Code