Skip to content

Commit 6a8a73d

Browse files
authored
docs: add dashboard usage overview previews (#62)
## Summary - Reframe the README console preview as a Dashboard preview. - Split the Dashboard preview into Connector Catalog and Usage Overview sections. - Add Overview screenshots that show runtime readiness, capability status, usage trends, recent failures, and recent calls. - Align the Dashboard preview section across English, Simplified Chinese, Japanese, Russian, and French READMEs. ## Problem The README already showed the connector catalog view, but it presented the screenshot as a generic local console preview. That made the Dashboard story less clear and did not show users the usage statistics they can inspect after deploying OpenConnector. ## Root Cause The documentation did not describe the Dashboard as a single product surface with multiple views. The connector catalog and the Overview usage statistics were not presented together, so users could miss that deployed runtimes include both connector browsing and operational usage visibility. ## Solution This PR reorganizes the README Dashboard section around two views: the Connector Catalog for browsing available connectors and the Usage Overview for deployment-time statistics. It adds English and Chinese Overview screenshots, uses the localized screenshots in the English and Chinese READMEs, and uses the English screenshots for the other localized READMEs. ## Validation - `npm run fix-check` - `git diff --check`
1 parent 829e90b commit 6a8a73d

7 files changed

Lines changed: 77 additions & 19 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,24 @@ handing provider credentials to the agent process.
6565
Endpoint details, response envelopes, auth headers, MCP tools, and Action guide examples are in
6666
[docs/runtime-api.md](docs/runtime-api.md).
6767

68-
## Local Console Preview
68+
## Dashboard Preview
6969

70-
OpenConnector ships with a local Web Console for browsing providers, configuring credentials,
71-
creating runtime tokens, and inspecting runs.
70+
OpenConnector ships with a local Dashboard for browsing connectors, configuring credentials,
71+
creating runtime tokens, and inspecting runtime usage.
7272

73-
![OpenConnector local console](assets/open-console-en.jpg)
73+
### Connector Catalog
74+
75+
Use the connector catalog to see available services, search for providers, and open their Actions
76+
and credential setup from one place.
77+
78+
![OpenConnector connector catalog dashboard](assets/open-console-en.jpg)
79+
80+
### Usage Overview
81+
82+
Use the Overview page after deployment to monitor runtime readiness, available providers,
83+
executable Actions, recent failures, tool call trends, and recent calls.
84+
85+
![OpenConnector runtime overview dashboard](assets/overview-page-en.jpg)
7486

7587
Provider names and trademarks belong to their respective owners and are used only for identification
7688
and interoperability.

assets/overview-page-en.jpg

359 KB
Loading

assets/overview-page-zh.jpg

344 KB
Loading

docs/README.fr.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,24 @@ utilisateurs sans donner les provider credentials au processus agent.
6767
Consultez [runtime-api.md](runtime-api.md) pour les endpoints, response envelopes, auth headers,
6868
outils MCP et exemples d'Action guide.
6969

70-
## Aperçu de la console locale
70+
## Aperçu du Dashboard
7171

72-
OpenConnector inclut une console Web locale pour parcourir les providers, configurer les
73-
credentials, créer des runtime tokens et inspecter les runs.
72+
OpenConnector inclut un Dashboard local pour parcourir les connectors, configurer les credentials,
73+
créer des runtime tokens et inspecter l'usage du runtime.
7474

75-
![Console locale OpenConnector](../assets/open-console-en.jpg)
75+
### Connector Catalog
76+
77+
Le connector catalog permet de voir les services disponibles, de rechercher des providers et
78+
d'ouvrir leurs Actions et leur credential setup depuis un seul endroit.
79+
80+
![OpenConnector connector catalog dashboard](../assets/open-console-en.jpg)
81+
82+
### Usage Overview
83+
84+
Après le déploiement, la page Overview affiche le runtime readiness, les providers disponibles, les
85+
Actions exécutables, les failures récentes, les tool call trends et les recent calls.
86+
87+
![OpenConnector runtime overview dashboard](../assets/overview-page-en.jpg)
7688

7789
Les noms et marques des providers appartiennent à leurs propriétaires respectifs et sont utilisés
7890
uniquement à des fins d'identification et d'interopérabilité.

docs/README.ja.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,24 @@ OpenConnector は、provider credential を Agent process に渡さずに、Agen
5959
Endpoint、response envelope、auth header、MCP tool、Action guide の例は
6060
[runtime-api.md](runtime-api.md) を参照してください。
6161

62-
## ローカルコンソールプレビュー
62+
## Dashboard プレビュー
6363

64-
OpenConnector には、providers の閲覧、credentials の設定、runtime token の作成、run log
65-
の確認に使えるローカル Web Console が含まれます。
64+
OpenConnector には、connectors の閲覧、credentials の設定、runtime token の作成、runtime usage
65+
の確認に使えるローカル Dashboard が含まれます。
6666

67-
![OpenConnector ローカルコンソール](../assets/open-console-en.jpg)
67+
### Connector Catalog
68+
69+
Connector catalog では、利用可能な services の確認、provider の検索、Actions と credential setup
70+
への移動を一か所から行えます。
71+
72+
![OpenConnector connector catalog dashboard](../assets/open-console-en.jpg)
73+
74+
### Usage Overview
75+
76+
デプロイ後は Overview page で runtime readiness、available providers、executable
77+
Actions、recent failures、tool call trends、recent calls を確認できます。
78+
79+
![OpenConnector runtime overview dashboard](../assets/overview-page-en.jpg)
6880

6981
Provider 名と商標はそれぞれの権利者に帰属し、識別と相互運用性のためにのみ使用されています。
7082

docs/README.ru.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,24 @@ OpenConnector подходит продуктам, где агентам нуж
6666
Подробности об endpoints, response envelopes, auth headers, MCP tools и примерах Action guide см. в
6767
[runtime-api.md](runtime-api.md).
6868

69-
## Обзор локальной консоли
69+
## Обзор Dashboard
7070

71-
OpenConnector включает локальную Web Console для просмотра providers, настройки credentials,
72-
создания runtime tokens и проверки run logs.
71+
OpenConnector включает локальный Dashboard для просмотра connectors, настройки credentials,
72+
создания runtime tokens и проверки runtime usage.
7373

74-
![Локальная консоль OpenConnector](../assets/open-console-en.jpg)
74+
### Connector Catalog
75+
76+
В connector catalog можно просматривать доступные services, искать providers и открывать их Actions
77+
и credential setup из одного места.
78+
79+
![OpenConnector connector catalog dashboard](../assets/open-console-en.jpg)
80+
81+
### Usage Overview
82+
83+
После развертывания страница Overview показывает runtime readiness, доступные providers,
84+
исполняемые Actions, недавние failures, tool call trends и recent calls.
85+
86+
![OpenConnector runtime overview dashboard](../assets/overview-page-en.jpg)
7587

7688
Названия и товарные знаки providers принадлежат их владельцам и используются только для
7789
идентификации и совместимости.

docs/README.zh-CN.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,21 @@ OpenConnector 适合需要让 Agent 持续访问用户现有工具、但不想
5757
Endpoint、response envelope、鉴权 header、MCP tools 和 Action guide 示例见
5858
[runtime-api.md](runtime-api.md)
5959

60-
## 本地控制台预览
60+
## Dashboard 预览
6161

62-
OpenConnector 内置本地 Web 控制台,可用于浏览 provider、配置 credential、创建 runtime token 和查看运行记录
62+
OpenConnector 内置本地 Dashboard,可用于浏览 connector、配置 credential、创建 runtime token 和查看运行时使用数据
6363

64-
![OpenConnector 本地控制台](../assets/open-console-zh.jpg)
64+
### Connector 预览
65+
66+
通过 connector catalog 可以查看可用服务、搜索 provider,并进入对应的 Action 与 credential 配置。
67+
68+
![OpenConnector Connector 预览 Dashboard](../assets/open-console-zh.jpg)
69+
70+
### 数据统计概览
71+
72+
部署后,Overview 页面会集中展示运行时状态、可用 provider、可执行 Action、最近失败、工具调用趋势和最近调用记录。
73+
74+
![OpenConnector 运行时概览 Dashboard](../assets/overview-page-zh.jpg)
6575

6676
Provider 名称和商标归各自权利人所有,本项目仅用于识别服务和实现互操作。
6777

0 commit comments

Comments
 (0)