docs: release-ready README, usage guide, and CHANGELOG#79
Merged
Conversation
Bring the docs to a shipped, present-tense state for the 0.5.0 launch. - README: replace the "early development / what it will do" framing with what Studio does today (inspect, detect, watch, prove, scale, script), a hero screenshot of the live inspector, an Install section (download the macOS .dmg / Linux .tar.gz from Releases, with the ad-hoc "right-click → Open" note), a Usage section (GUI + the real CLI commands), and a build-from-source section pointing at RELEASING.md. - CHANGELOG.md: Keep-a-Changelog, with the 0.5.0 notes staged under [Unreleased] (S0–S5 additions + known limitations); the release-cut issue dates it. - docs/assets/inspector.png: the hero screenshot, rendered by the driven GUI suite under Xvfb (compressed to ~107 KB). Screenshot is the real automation-captured inspector (timeline + message inspector + session panel + failure drawer). No maintainer email in any committed doc. `studio ci` still exits 0. Closes #73.
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
1 participant
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.
Brings the docs to a shipped, present-tense state for the 0.5.0 launch.
README
.dmg/ Linux.tar.gzfrom Releases, with the ad-hoc right-click → Open note.capture,inspect,report,diff,anonymize,ci), taken fromstudio --help.RELEASING.md.CHANGELOG
CHANGELOG.md(Keep-a-Changelog) with the 0.5.0 notes staged under[Unreleased]— the S0–S5 additions grouped by capability, plus known limitations (ad-hoc signing, the 50k detection cap, deferred TLS / menu-bar / interactive-open). The release-cut issue (#74) dates it.Screenshot provenance
docs/assets/inspector.pngis the real image the driven GUI suite (#71) captured under Xvfb — the inspector loaded on the sample trace with an event selected — re-compressed from 3.8 MB to ~107 KB. (Only the inspector frame is used; under software GL the post-click "live" frame lagged, so I didn't ship a misrepresented one.)Verification
All README-referenced local files exist; no maintainer email in any committed doc (private advisory link only);
studio cistill exits 0.Closes #73.