docs(docs): complete showcase dogfood screenshots#333
Merged
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideReplaces placeholder HTML comments in the showcase walkthrough docs with actual screenshot markdown links and descriptive alt text, wiring five new dogfood-generated PNGs into the user guide without touching any application or infrastructure code. Flow diagram for wiring showcase screenshots into docsflowchart LR
ShowcaseWalkthroughMD[showcase-walkthrough.md]
KPIStrip[kpi-strip.png]
InspectArtifacts[inspect-artifacts-panel.png]
RunHistory[run-history-strip.png]
OpsSnapshot[ops-snapshot-tiles.png]
AgentHITL[agent-hitl-approve.png]
ShowcaseWalkthroughMD -- markdown_image_link --> KPIStrip
ShowcaseWalkthroughMD -- markdown_image_link --> InspectArtifacts
ShowcaseWalkthroughMD -- markdown_image_link --> RunHistory
ShowcaseWalkthroughMD -- markdown_image_link --> OpsSnapshot
ShowcaseWalkthroughMD -- markdown_image_link --> AgentHITL
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- Some of the new alt texts are quite long and include implementation details (e.g.,
save_scenariobehavior); consider shortening them to focus on what’s visually on screen and move explanatory context into the surrounding paragraph for better readability and accessibility. - Tool and flow names like
agent_hitl_flowandsave_scenarioare referenced inline in prose; consider wrapping these in backticks for consistency with the rest of the docs’ code/identifier styling.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Some of the new alt texts are quite long and include implementation details (e.g., `save_scenario` behavior); consider shortening them to focus on what’s visually on screen and move explanatory context into the surrounding paragraph for better readability and accessibility.
- Tool and flow names like `agent_hitl_flow` and `save_scenario` are referenced inline in prose; consider wrapping these in backticks for consistency with the rest of the docs’ code/identifier styling.
## Individual Comments
### Comment 1
<location path="docs/user-guide/showcase-walkthrough.md" line_range="159" />
<code_context>
[Agents and RAG Guide](./agents-and-rag-guide.md) for the approval gate.
-<!-- screenshot: agent-hitl-approve.png -->
+
### Phase: Ops snapshot
</code_context>
<issue_to_address>
**suggestion (typo):** Consider adding a missing auxiliary verb in "so the step skipped by design".
This reads slightly ungrammatically; consider "so the step is skipped by design" (or "was skipped," depending on tense).
```suggestion
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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.
Summary
Completes the PRP-42 PR2 walkthrough by capturing the five remaining
/showcasescreenshots from a live, greenshowcase_richdogfood run and wiring them intodocs/user-guide/showcase-walkthrough.md. Docs-only — no app, frontend, alembic, or dependency changes.The dogfood ran the full end-to-end pipeline from the browser and reached "Pipeline complete" (winner
prophet_like, ~16 s): 24 steps, 18/18 batch items, RAG knowledge phase real against thedocs/user-guide/corpus (ollamaqwen3-embedding:4b, 37 chunks), agent phase on Gemini, scenario plans persisted, ops snapshot computed.Screenshots added (
docs/user-guide/img/)kpi-strip.png— KPI strip (runs 1 · aliases 1 · batch 18 · plans 2 · RAG chunks 37)inspect-artifacts-panel.png— the 10-card deep-link Inspect-Artifacts gridrun-history-strip.png— Recent-runs strip (showcase_rich PASS 16s+ Replay)ops-snapshot-tiles.png— Ops-snapshot step card + five-tile KPI gridagent-hitl-approve.png— Agents (HITL) step cardNotes
save_scenario(the gated tool), soagent_hitl_flowskipped by design and the one-click Approve button did not render. This matches the "visible or documented if skipped" criterion; the alt text reflects it./showcasewhite-screens at completion over LAN HTTP (crypto.randomUUID is not a function— LAN-IP origin is not a secure context). The backend completes fine; screenshots were captured vialocalhost(a secure context). Out of scope for this docs PR.Validation
grep -c "<!-- screenshot:" docs/user-guide/showcase-walkthrough.md→ 0git diff --stat→ onlyshowcase-walkthrough.md+ the new imagesapp//frontend//alembic//uv.lock/ env changes; no secrets in filenames or markdownCloses #331
Summary by Sourcery
Documentation:
/showcasewalkthrough screenshots into the user guide with detailed, accessible alt text describing each UI element.