docs: README restyle — short core-value, zh mirror, animated hero - #534
Conversation
- README.md: 190 -> ~80 lines, one idea up front — container is the sandbox, mounts are the contract; deep docs cut to docs.deva.sh - README.zh-CN.md: section-for-section zh mirror, language switcher - docs/assets/deva-hero.svg: terminal card, gradient wordmark, blinking cursor, agent-name typing loop (SMIL, plays via img) - CHANGELOG: backfill #517 pin refresh under Unreleased Closes #533 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR restyles the repository’s top-level documentation to foreground deva’s core value proposition (“the container is the sandbox, mounts are the contract”), adds a Simplified Chinese README that mirrors the English structure, and introduces an animated SVG hero asset for README presentation.
Changes:
- Condense
README.mdto a short “core in four lines” version and point deep documentation todocs.deva.sh. - Add
README.zh-CN.mdas a section-for-section Simplified Chinese mirror with a language switcher. - Add
docs/assets/deva-hero.svg(SMIL-animated hero) and backfill related notes intoCHANGELOG.mdunder Unreleased.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Shortened, repositioned messaging, simplified command/docs pointers, and added hero + language switcher. |
| README.zh-CN.md | New Simplified Chinese README mirroring the English layout and content intent. |
| docs/assets/deva-hero.svg | New animated SVG hero used by both READMEs. |
| CHANGELOG.md | Documents the README restyle and backfills the prior pins refresh under Unreleased. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ce1e4f8344
ℹ️ 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".
| - Not magic. If you mount your whole home read-write and hand the agent dangerous permissions, the agent can touch your whole home. Amazing how that works. | ||
| - The container is the sandbox. All five agents run inside it with their built-in permission systems disabled (`claude --dangerously-skip-permissions`, `codex --dangerously-bypass-approvals-and-sandbox`, `gemini --yolo`, `grok --always-approve`, `kimi --yolo`). Isolation comes from Docker, not permission theater. | ||
| - Mounts are the contract. Nothing crosses the host boundary except what you explicitly mount. No mystery behavior. | ||
| - One warm persistent container per project, shared by all five agents. Packages, build caches, and scratch state stay warm instead of being rebuilt every run. |
There was a problem hiding this comment.
This now tells users all five agents share one persistent project container, but the launch code still includes the active agent in the container name (build_container_name() uses the agent segment), so deva.sh claude and deva.sh codex attach to separate persistent containers even for the same project and shape. Users relying on packages, build caches, or scratch state warmed by one agent will not see them in another; please keep the wording to shared image/shape or update the lifecycle code, and mirror the fix in README.zh-CN.md.
Useful? React with 👍 / 👎.
One idea up front: the container is the sandbox, mounts are the contract.
wordmark, blinking cursor, agent-name typing loop), echoes deva.sh site
Closes #533
Preview the hero: https://raw.githubusercontent.com/thevibeworks/deva/docs/readme-restyle-533/docs/assets/deva-hero.svg
🤖 Generated with Claude Code