diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4287934fc..9dbcd689c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,4 +117,4 @@ Provider bootstrap, Runtime images and Harness adapters must agree on these name ## Branding -Use OpenAgentCore for public project branding. The canonical mark is `docs/assets/openagentcore-logo.svg`; Web uses its outline with cropped transparent margins, theme-aware favicon colors and dark-surface inversion. The README wordmark is `docs/assets/openagentcore-wordmark-light.svg` with a dark variant, and `docs/assets/og-image.png` is the social preview. The architecture diagram that README and the website show, `docs/assets/architecture.svg` and `architecture-dark.svg`, is generated by `scripts/generate-architecture-diagram.py`; change the script and run it again. The `example/parsar/` example keeps its own name, logo and favicon. +Use OpenAgentCore for public project branding. The canonical mark is `docs/assets/openagentcore-logo.svg`; Web uses its outline with cropped transparent margins, theme-aware favicon colors and dark-surface inversion. The README banner is `docs/assets/openagentcore-banner.webp`, and `docs/assets/og-image.png` is the social preview. The architecture diagram that README and the website show, `docs/assets/architecture.svg` and `architecture-dark.svg`, is generated by `scripts/generate-architecture-diagram.py`; change the script and run it again. The `example/parsar/` example keeps its own name, logo and favicon. diff --git a/README.md b/README.md index e37a32794..0170d3a94 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,6 @@
- - - OpenAgentCore - +![OpenAgentCore — One core. Many agents.](docs/assets/openagentcore-banner.webp) The OpenAI Agents API, open source and self-hosted. Run Codex, Claude Code or MiniMax Code on your own machines with your own models, through the official OpenAI SDK. @@ -15,7 +12,7 @@ The OpenAI Agents API, open source and self-hosted. Run Codex, Claude Code or Mi
-

Deployment overview

+![Deployment overview](docs/assets/console-overview-en.webp) - **Same API as OpenAI.** Set `OPENAI_BASE_URL` and the [official OpenAI SDK](https://developers.openai.com/api/docs/libraries), or plain HTTP, works unchanged. - **Your agent, your model.** Each Session runs Codex, Claude Code or MiniMax Code natively, as it runs on your machine, with the model provider you configure. See [Harness capabilities](https://openagentcore.dev/contracts/agents-api/harness-capabilities). diff --git a/README.zh-CN.md b/README.zh-CN.md index 2282ecfac..a3d62b01b 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,9 +1,6 @@
- - - OpenAgentCore - +![OpenAgentCore — One core. Many agents.](docs/assets/openagentcore-banner.webp) 开源、可自部署的 OpenAI Agents API。用官方 OpenAI SDK,在你自己的机器上用你自己的模型运行 Codex、Claude Code 或 MiniMax Code。 @@ -15,7 +12,7 @@
-

部署概览

+![部署概览](docs/assets/console-overview-zh.webp) - **与 OpenAI 相同的 API。** 设置 `OPENAI_BASE_URL` 后,[官方 OpenAI SDK](https://developers.openai.com/api/docs/libraries)或直接的 HTTP 调用无需改动即可使用。 - **你的 Agent,你的模型。** 每个 Session 原生运行 Codex、Claude Code 或 MiniMax Code,使用你配置的模型提供商,与在本机运行一致。详见 [Harness 能力](https://openagentcore.dev/zh/contracts/agents-api/harness-capabilities)。 diff --git a/docs/assets/openagentcore-banner.webp b/docs/assets/openagentcore-banner.webp new file mode 100644 index 000000000..3450d2f0d Binary files /dev/null and b/docs/assets/openagentcore-banner.webp differ diff --git a/docs/assets/openagentcore-wordmark-dark.svg b/docs/assets/openagentcore-wordmark-dark.svg deleted file mode 100644 index e1883c2b8..000000000 --- a/docs/assets/openagentcore-wordmark-dark.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/assets/openagentcore-wordmark-light.svg b/docs/assets/openagentcore-wordmark-light.svg deleted file mode 100644 index 1b9ea0665..000000000 --- a/docs/assets/openagentcore-wordmark-light.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/scripts/core-distribution-manifest.py b/scripts/core-distribution-manifest.py index 05b985336..7618bea85 100644 --- a/scripts/core-distribution-manifest.py +++ b/scripts/core-distribution-manifest.py @@ -52,8 +52,7 @@ ) # Files the bundled docs show, copied as they are, so they work offline. BUNDLED_FILES = ( - "docs/assets/openagentcore-wordmark-light.svg", - "docs/assets/openagentcore-wordmark-dark.svg", + "docs/assets/openagentcore-banner.webp", "docs/assets/architecture.svg", "docs/assets/architecture-dark.svg", "docs/assets/console-overview-en.webp",