docs: explain the install behavior diff - #10
Closed
kiranmagic7 wants to merge 1 commit into
Closed
Conversation
Signed-off-by: Kiran <262980978+kiranmagic7@users.noreply.github.com>
Owner
Author
|
Supersession note: the current v3-compatible example and README path are integrated in draft PR #31. Do not apply this older standalone documentation patch into the current stack without reconciliation. |
Owner
Author
|
Superseded by the consolidated PR #31. The useful README and exact example work is retained there. Closing this standalone draft to keep one active upgrade review branch. No merge, release, or launch occurred. |
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.
What changed
The README now explains BehaviorLock in plain language as a before and after observation of
npm install. It walks through the five steps, keeps the experimental warning above the fold, and shows the exact three row diff produced by the inert fixtures.A new
docs/EXAMPLE_DIFF.mdpage contains the reproducible commands, the full unedited report, the expected compare exit code, and a short explanation of what the result does and does not mean.Why
The repository explained the architecture before showing a real result. A first time visitor can now understand the tool, inspect its output, and see the evidence rather than verdicts boundary without reading the full technical reference.
Impact
Documentation only. This does not change the CLI, schemas, capture path, sandbox, policy levels, or release state. It does not add promotion or distribution work.
Verification
AF_INET:target.1, which is the expected review signal.make checksuccessfully.make buildsuccessfully.git diff --checksuccessfully.AI assistance
AI tools assisted with drafting, reproduction, and verification. The submitted text and commands were reviewed against the current repository output.