Skip to content

docs: README core block — outcomes, not mechanism - #537

Merged
lroolle merged 1 commit into
mainfrom
docs/readme-value-outcomes
Aug 5, 2026
Merged

docs: README core block — outcomes, not mechanism#537
lroolle merged 1 commit into
mainfrom
docs/readme-value-outcomes

Conversation

@lroolle

@lroolle lroolle commented Aug 5, 2026

Copy link
Copy Markdown
Member

The old core block sold the mechanism (container = sandbox) and stopped. Senior devs buy outcomes; the block now states the mechanism once and lists the six things it buys: full-speed YOLO, vendor code caged off the host, explicit file/env/network boundary, per-run identity, stock official CLIs (containment as the compatibility layer, not protocol shims), naked-CLI feel.

All flags named are verified in deva.sh (--auth-with:2399, --config-home:143, --host-net:159).

Closes #536

🤖 Generated with Claude Code

- mechanism stated once, then six outcomes: full-speed YOLO (blast
  radius = container), vendor code never sees host, explicit
  boundary (files/env/network), identity as launch flag
  (--auth-with/--config-home), official CLIs stock — containment as
  the compatibility layer, feels like the naked CLI
- zh mirror kept in lockstep; llms.txt gains per-run auth switching

Closes #536

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 5, 2026 03:23

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README “core-value” block to emphasize operator outcomes (what containerized agents buy you) rather than leading with the underlying mechanism, and carries the same framing through the repo’s LLM-oriented synopsis and changelog.

Changes:

  • Rewrite the core value section in README.md and README.zh-CN.md into six outcome-focused bullets.
  • Update llms.txt to reflect per-run identity switching via --auth-with / --config-home.
  • Add an Unreleased changelog entry noting the documentation reframing (Issue #536).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
README.zh-CN.md Replaces the “core in four lines” block with six outcome bullets (ZH).
README.md Replaces the “core in four lines” block with six outcome bullets (EN).
llms.txt Updates identity/auth summary to mention per-run switching flags.
CHANGELOG.md Notes the README rewrite under Unreleased → Changed.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread llms.txt
mount. Known sharp edge: mounting `/var/run/docker.sock` is host-root with
API-key modes per agent, switchable per run (`--auth-with`, `--config-home`) so
accounts and billing modes swap without touching project or session state;
nothing crosses the host boundary except what you mount. Known sharp edge: mounting `/var/run/docker.sock` is host-root with

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d7e6af159f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
- It's a bash script, not a framework.
The container is the sandbox, mounts are the contract. What that buys you:

- Full-speed agents. Permission prompts exist because the blast radius is your host. Make the blast radius a container and YOLO stops being reckless — all five agents run with their permission systems off (`claude --dangerously-skip-permissions`, `codex --dangerously-bypass-approvals-and-sandbox`, `gemini --yolo`, `grok --always-approve`, `kimi --yolo`). Worst case dies with the container.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Clarify that host mounts outlive the container

In normal deva launches, deva.sh bind-mounts the current workspace read-write (-v "$(pwd):$(pwd)") and, unless --no-docker is used, also mounts /var/run/docker.sock when present (deva.sh:1932-1963). With all agent approvals disabled, a bad prompt or compromised CLI can rewrite/delete the host repo or control host Docker, so the worst case does not necessarily die with the container; this sentence should keep the host-mount caveat explicit, and the same fix should be mirrored in README.zh-CN.md.

AGENTS.md reference: AGENTS.md:L8-L10

Useful? React with 👍 / 👎.

@lroolle
lroolle merged commit baeec01 into main Aug 5, 2026
5 checks passed
@lroolle
lroolle deleted the docs/readme-value-outcomes branch August 5, 2026 03:29
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.

README: core-value section sells the mechanism, not the outcomes

2 participants