Repository navigation
docs: a shorter, visual README - #10
Merged
Merged
Conversation
Lead with what an actor brings back, the two ways in (coding agent and Studio), the run, read, fix, re-run loop and cloud runs, with real Studio screenshots in light and dark and a diagram of how the agent, the .stuntdouble/ files and Studio fit together. The long setup, agent, tools, files and safety detail moves to docs/studio.md, docs/coding-agents.md and docs/files-and-safety.md, unchanged in substance. Guided setup and agent hand-off are marked as coming in the next release. Signed-off-by: Michael Parker <michael@stuntdouble.io>
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 so a new reader gets it in one screen: what Studio does, the two ways to use it (from your coding agent, or as a local app), the run, fix and re-run loop, and cloud runs. It now has real screenshots in light and dark (
<picture>withprefers-color-scheme) and one diagram of how your agent, the.stuntdouble/files and Studio fit together.The longer reference moves, with its wording kept, into
docs/studio.md,docs/coding-agents.mdanddocs/files-and-safety.md.Notes for review
package.jsonfilesdoesn't includedocs/, so check the npm page renders the images after the next publish.Verification
pnpm format:check