docs(readme): rework for user-facing clarity#73
Merged
Conversation
…-first statefulness, clearer scenario/script terms)
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
Addresses reader feedback that the README leans on internal jargon and internal architecture rather than the user's point of view. No functional change — docs only.
Changes
.scpi); "scenario" as aquery → responserule set. The overlapping record bullets are consolidated into run a mock / capture then replay / run & lint SCPI scripts, andvisa scriptis surfaced for the first time (linked to ADR 0027). All features referenced are verified present (MockScenarioCommandrecord --from-script,VisaScriptCommand).use-first statefulness. The lead Highlights bullet now frames the current device like a shell's working directory:visa addregisters,visa useselects, and later commands need no target at all.([日本語])/([English])links are removed; only the top-of-file switcher remains. Recorded in ADR 0024 §4 (navigation links point to the English canonical only, so index lines don't grow per added language).Both
README.mdanddocs/README.jp.mdupdated in lock-step (i18n sync check).Verification
#architectureanchors; ADR 0027 link resolves; only the two top switcher headers remain.