docs(quickstart): add install, onboard, and investigation demo GIFs#2663
docs(quickstart): add install, onboard, and investigation demo GIFs#2663amsorrytola wants to merge 8 commits into
Conversation
Add a short terminal GIF after the "Install OpenSRE" step showing the one-line curl installer running to a successful install, so new users can see the expected workflow. Part of Tracer-Cloud#2658.
Add a terminal GIF after the "Onboard" step showing the setup wizard configuring an LLM provider (key entry masked) and an integration through to a successful "Done" summary. Part of Tracer-Cloud#2658.
Add a terminal GIF after the "Run an investigation" step showing a one-shot `opensre investigate` run on the sample alert through to a structured root-cause report. Completes Tracer-Cloud#2658.
Greptile code reviewThis repo uses Greptile for automated review. Before merge, aim for Confidence Score: 5/5 with zero unresolved review threads — see CONTRIBUTING.md. Run a review — add a PR comment with: Give it ~5-10 minutes (sometimes longer) for results, then fix feedback and re-trigger until you reach Confidence Score: 5/5. Optional: automate with the greploop skill. |
Greptile SummaryThis PR adds three terminal GIF demos to
Confidence Score: 4/5Documentation-only change adding three GIF assets and their Frame embeds — no logic, no config, and no breaking changes. All changes are confined to a docs page and binary image assets. The GIF files are correctly placed in docs/images/ and referenced with valid relative paths. The only finding is a cosmetic indentation mismatch inside Frame tags compared to the style used elsewhere in the docs. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[quickstart.mdx] --> B[Step 1: Install OpenSRE]
A --> C[Step 2: Onboard]
A --> D[Step 3: Run an investigation]
A --> E[Step 4: Keep up to date]
B --> B1[Frame: quickstart-install.gif NEW]
C --> C1[Frame: quickstart-onboard.gif NEW]
D --> D1[Frame: quickstart-investigate.gif NEW]
B1 --> F[docs/images/]
C1 --> F
D1 --> F
Reviews (1): Last reviewed commit: "docs(quickstart): add investigation step..." | Re-trigger Greptile |
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
The install GIF demonstrates the curl installer, which is macOS/Linux only. Placing it below the <Tabs> made it show under the Windows tab too. Move it inside the macOS/Linux tab so it no longer mismatches the Windows (irm | iex) instructions. Windows demo to follow separately.
Add Windows (PowerShell) GIF demos alongside the existing macOS/Linux ones for all three Quickstart steps. Install gets a per-OS GIF in each command tab; Onboard and Investigate wrap their GIFs in macOS/Linux + Windows tabs since the commands are identical across platforms. Part of Tracer-Cloud#2658.
Fixes #2658
Describe the changes you have made in this PR -
Adds short terminal GIF demonstrations after the first three Quickstart steps, as requested in #2658, so new users can see the expected workflow and a successful run of each step — now with both macOS/Linux and Windows demos:
curl … | bashfor macOS/Linux,irm … | iexfor Windows).opensre onboardwizard configuring an LLM provider (API key entry masked) and an integration, through to the✓ Donesummary.opensre investigateon the bundled sample alert, producing a structured root-cause report (findings, recommended actions, cited evidence).Structure: the Install step keeps its per-OS command tabs and now has a GIF in each. Onboard and Investigate wrap their GIFs in
macOS / Linux+Windowstabs (the commands are identical across platforms). All GIFs use the existing<Frame>component, with assets underdocs/images/. Nodocs.jsonchange is needed sincequickstartis already a registered page.How the GIFs were produced
asciinema, rendered withagg.ffmpeg(cropped + palette-optimized).Demo/Screenshot for feature changes and bug fixes -
📹 Walkthrough of the final rendered docs page: https://vimeo.com/1196780409
macOS / Linux
1. Install
2. Onboard
3. Run an investigation
Windows (PowerShell)
1. Install
2. Onboard
3. Run an investigation
Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?
If you used AI assistance:
Explain your implementation approach:
The change is documentation-only:
<Frame>-wrapped GIFs added todocs/quickstart.mdx, one (or a macOS-Linux/Windows tab pair) per step. macOS/Linux sessions were recorded withasciinemaand converted withagg; Windows sessions were screen-recorded on PowerShell and converted withffmpeg(crop + palette). I used<Frame>+/images/...because that is the established pattern across the existing docs pages, and kept the files small so they're comfortable to commit. The Install step uses per-OS tabs because the command differs; Onboard and Investigate share one command, so only their GIFs are tabbed by OS.Checklist before requesting a review
Note: Allow edits from maintainers is enabled.