fix: add screenshots.#13
Open
nkanf-dev wants to merge 1 commit into
Open
Conversation
Contributor
|
@nkanf-dev is attempting to deploy a commit to the Antony's projects Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenAgent documentation by replacing screenshot placeholders with real product screenshots across provider, store, auditing, and admin docs.
Changes:
- Replace multiple
<Callout type="warn">screenshot placeholders with actual screenshots (providers, stores, logs, admin pages). - Add/introduce new screenshot assets under
public/img/docs/openagent/(e.g., forbidden words, split provider, auditing pages). - Keep Users guidance pointing to Casdoor documentation instead of embedding screenshots.
Reviewed changes
Copilot reviewed 10 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| public/img/docs/openagent/forbidden-words.png | Adds Store “Forbidden Words” screenshot asset used in Stores docs. |
| content/docs/connectors/providers/storage-providers.mdx | Replaces placeholder with Storage provider screenshot. |
| content/docs/connectors/providers/model-providers.mdx | Adds explanatory callout + screenshot for dynamic provider form fields. |
| content/docs/connectors/providers/embedding-providers.mdx | Replaces placeholder with Embedding provider screenshot. |
| content/docs/basic/stores.mdx | Adds screenshots for Split Provider, Forbidden Words, and Child Stores sections. |
| content/docs/auditing-logs/logs.mdx | Replaces placeholder with Records + Usage screenshots. |
| content/docs/admin/users.mdx | Switches to Casdoor link callout (no screenshots). |
| content/docs/admin/system-info.mdx | Replaces placeholder with System Info screenshot. |
| content/docs/admin/sites.mdx | Replaces placeholder with Settings screenshot (but file/content naming looks inconsistent). |
| content/docs/admin/settings.mdx | Replaces placeholder with Settings screenshot. |
| content/docs/admin/enterprise-sso.mdx | Switches to Casdoor link callout (but page appears to be “Users” content under an “Enterprise SSO” title). |
Comments suppressed due to low confidence (2)
content/docs/admin/settings.mdx:19
Calloutis imported but no longer used on this page after replacing the placeholder with an image. If MDX/ESLint checks are enabled for docs, this can trip unused-import rules; consider removing the unused import.
- Site-level presentation
- Footer content
- Which product areas are visible in the built-in site navigation
content/docs/admin/system-info.mdx:19
Calloutis imported but the page no longer contains any<Callout>blocks after swapping the placeholder for an image. Consider removing the unused import to avoid unused-import lint issues.
- Version and build information
- Runtime environment details
- High-level system status
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
8
to
+12
| # Users | ||
|
|
||
| User accounts and authentication are managed through [Casdoor](https://casdoor.org), the SSO service bundled in OpenAgent's stack. The OpenAgent admin panel exposes the controls you need day-to-day — roles, account status, permissions, and sessions — without requiring you to navigate Casdoor directly for most operations. | ||
|
|
||
| <Callout type="warn"> | ||
| **Screenshot placeholder:** Users list page + editing a user role (Admin / Chat Admin / Regular). | ||
| Keep it production-oriented: show how an operator would grant access safely. | ||
| <Callout type="info"> |
Comment on lines
14
to
+18
| - Site-level presentation | ||
| - Footer content | ||
| - Which product areas are visible in the built-in site navigation | ||
|
|
||
| <Callout type="warn"> | ||
| **Screenshot placeholder:** The Settings page showing built-in site settings such as footer content and visible navigation items. | ||
| </Callout> | ||
|
|
||
|  |
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
This PR replaces multiple OpenAgent docs screenshot placeholders with real product screenshots and updates the related docs to match. It adds screenshots for admin pages, auditing pages, model/embedding/storage providers, and key Store configuration sections such as split provider, forbidden words, and child stores. It also keeps the Users docs pointing to Casdoor documentation instead of using screenshots.