docs(editor): clarify agent workflows and upcoming release features - #351
Merged
Conversation
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.
Why
Red's public documentation and onboarding understate its editor-aware Agent, focused inline assistance, and Vim compatibility. Some existing copy also implies that all Agent writes require manual approval, which incorrectly describes the distinction between saved full-Agent edits and unsaved inline edits.
What Changed
README.mdaround editor-aware Codex conversations, inline assistance, Vim fluency, and the bundled terminal-editor workflow while clearly separating published v0.6.0 behavior from features currently available only onmain.docs/GETTING_STARTED.md,docs/AGENT_WORKFLOW.md, anddocs/VIM_COMPATIBILITY.mdwith multi-cursor commands, source-linked Agent explanations, conversation-specific model selection, external-file conflict recovery, completion behavior, formatting, and exact inline targeting.docs/RELEASE_COMMUNICATIONS_CONVERSATION.md, excluding runtime/tool metadata, credentials, and machine-specific absolute paths.Companion release automation: #350.
How to Test
python3 scripts/readme_release.py --check; the README should continue to match the published package version without advertising upcomingmainfeatures as released.cargo test -p red --lib tutorial::testsandcargo test -p red --lib ui::welcome::tests; all five tutorial tests and four welcome tests should pass, including the full-Agent versus inline save-boundary assertions.Space idescribes enclosing-function targeting and exact Visual selections./Users/...paths.