Update Playground documentation with current UI screenshots #90
Conversation
- Add dark mode screenshot for Playground page - Update text to match current UI elements (dropdown labels, button text) - Add links to Testsets and Prompts pages for creating new items - Improve accessibility text for images
Summary of ChangesHello @Yash1hi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the accuracy and usability of the Playground documentation. It updates existing content to align with the latest UI, introduces dark mode visuals, and improves navigation through new links to related features. The primary goal is to provide users with a more current and accessible guide to the Playground. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
🖼️ Image Usage Check ✅All 224 images in the repository are being used! No unused images found. Great job keeping the repository clean! 🎉 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request does a great job of updating the Playground documentation to match the current UI. The addition of a dark mode screenshot, more descriptive alt text, and updated workflow descriptions significantly improve the quality and usability of the documentation. I've added a few minor suggestions to improve stylistic consistency with other documentation files by bolding UI element labels. Overall, these are excellent changes.
features/playground.mdx
Outdated
|
|
||
| **Choose a Testset:** | ||
| - Click the testset dropdown at the top of the left panel | ||
| - Click the "Choose Testset" dropdown at the top left |
There was a problem hiding this comment.
For consistency with other documentation pages (e.g., testsets.mdx, prompts.mdx), UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"Choose Testset"** for consistency.
- Click the **"Choose Testset"** dropdown at the top left
features/playground.mdx
Outdated
| **Choose a Prompt:** | ||
| - Select a prompt from the dropdown in the header | ||
| - If no prompts exist, click "Create prompt" to create one directly from the Playground | ||
| - Select a prompt from the "Prompt" dropdown at the top of the middle panel |
There was a problem hiding this comment.
For consistency with other documentation pages, UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"Prompt"** for consistency.
- Select a prompt from the **"Prompt"** dropdown at the top of the middle panel
features/playground.mdx
Outdated
| - Remove messages with the trash can icon | ||
| - The editor supports [Jinja syntax](https://jinja.palletsprojects.com/) for dynamic content | ||
| - Insert variables from your testcase data like `{{variable_name}}` or use `{{allInputs}}` for all inputs | ||
| - Add multiple messages by clicking "+ ADD MESSAGE" |
There was a problem hiding this comment.
For consistency with other documentation pages, UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"+ ADD MESSAGE"** for consistency.
- Add multiple messages by clicking **"+ ADD MESSAGE"**
features/playground.mdx
Outdated
| - Save new versions of your prompts with the "Save" button | ||
| - Switch between versions to compare performance | ||
| - Publish versions to production when ready | ||
| - Save new versions of your prompts with the "SAVE" button in the header |
There was a problem hiding this comment.
For consistency with other documentation pages, UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"SAVE"** for consistency.
- Save new versions of your prompts with the **"SAVE"** button in the header
- Complete rewrite to reflect new node-based workflow interface - Updated screenshots showing testset panel, agent node, evaluator node - New sections: Workflow Components, Workflow Controls, Visual Flow - Added Related Features card group at bottom - Removed outdated three-panel interface description
- Updated screenshots to show actual evaluation results (1/3 completed) - Shortened documentation from ~180 lines to ~50 lines - Focused on essential quick start steps
- New screenshots showing node-based workflow with completed evaluation - Documented the five workflow components: Testset, Agent, Evaluator, Results, Scores - Concise documentation focused on the visual workflow experience
- Higher resolution (1920x1080) - Collapsed sidebar for cleaner view - Professional org name (Acme Inc) and project (Customer Support Bot) - Removed dev indicators - Shows completed evaluation with results and scores
- Add metadata search documentation with ClickHouse performance notes - Document clickable table rows feature for improved discoverability - Add filtering options section with comprehensive filter list - Include tips about interactive elements behavior Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
- Document enhanced LangChain/Traceloop adapter support - Add span classification details for workflow, task, and tool spans - Include tool visualization and coloring information - Document support for both OpenInference and Traceloop attribute formats Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
- Document default exclusion of monitor-created runs from main list - Add clickable table rows information for grades/records tables - Include note about filtering to view monitor runs specifically - Add tips about interactive elements in table rows Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
Summary
Changes
Test plan