Show the actual client record before setup - #104
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The PR is documentation-only, and the sole review comment is a non-blocking grammar nit.
Review effort: Lite
Findings: None
What changed in this PR
Documentation-only update showcasing an actual client record and offline report before setup, with corrected availability guidance and v0.6.1 release notes.
Changes:
- Adds sample record, offline HTML report, and preview documentation.
- Links the client evidence example across tool and project documentation.
- Updates availability guidance and release presentation.
| File | Summary | Review note |
|---|---|---|
tools/README.md |
Links the client evidence example. | — |
tools/demo-client-record/README.md |
Documents the generated handoff and outputs. | — |
tools/demo-client-record/example/report.html |
Provides the offline rendered report. | Nit: singularize “1 unresolved mapping.” |
tools/demo-client-record/example/record.json |
Provides the complete portable evidence record. | — |
tools/demo-client-record/example/README.md |
Documents offline inspection commands. | — |
README.md |
Adds the client evidence preview and corrected guidance. | — |
docs/releases/v0.6.1.md |
Documents the release presentation and sample outputs. | — |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Show the product output before setup: the README and v0.6.0 release-note text now open with an actual report screenshot, the commands that create it, full inspectable record.json and downloadable offline HTML. Correct stale availability guidance and record the output-first documentation rule in AGENTS.md.
The sample was generated by the released v0.6.0 binary in a neutral temporary workspace, inspected offline, and rendered to HTML from the exact JSON bytes. The screenshot was visually checked and the inline excerpt matches the full record.
Documentation only. No CLI, workflow, binary, tag or new-release changes. Existing v0.6.0 release text will receive the matching editorial update after merge. Related to #94; no additional tracking ticket.