Adding image of UI to readme #54
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a visual element to the README by including a screenshot of the OpenAI Guardrails configuration UI. The image is clickable and directs users to the configuration website at guardrails.openai.com.
Key changes:
- Added a new WebP image file containing a screenshot of the Guardrails configuration interface
- Embedded the image in the README as a clickable link positioned after the introduction and before the Installation section
Reviewed Changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/assets/images/guardrails-python-config-screenshot-100pct-q70.webp | New screenshot image of the Guardrails configuration UI in WebP format |
| README.md | Added clickable image linking to the configuration website, positioned between the introduction and Installation section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Most users can simply follow the guided configuration and installation instructions at [guardrails.openai.com](https://guardrails.openai.com/). | ||
|
|
||
| [](https://guardrails.openai.com) |
There was a problem hiding this comment.
The alt text "OpenAI Guardrails configuration screenshot" could be more descriptive for users relying on screen readers. Consider describing what's actually shown in the image, such as "Screenshot of the OpenAI Guardrails configuration interface showing guardrail options and settings" or similar, depending on what the image depicts.
| [](https://guardrails.openai.com) | |
| [](https://guardrails.openai.com) |
Added a screen shot of the UI to the README. It is clickable and takes the user to the config UI
This is what it looks like. I kept the link in the sentence before it as well as it is not obvious that you can click on the image but let me know if you want me to remove it