From c5d67f24d8aa3ae688613a32874004a62c3fd8ab Mon Sep 17 00:00:00 2001 From: Aldrich_CC <109075336+Chen17-sq@users.noreply.github.com> Date: Sat, 16 May 2026 04:35:31 +0800 Subject: [PATCH] docs: normalize clone URL and package manager to repo's current shape MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Several docs still tell people to clone `ekailabs/ekai-gateway` and use `npm`, while `CONTRIBUTING.md` documents a `pnpm` workspace flow. The repo's canonical name is now `ekailabs/contexto`; this PR makes the docs match. Changes (per the scoping in issue #135): * `git clone https://github.com/ekailabs/ekai-gateway.git` → `https://github.com/ekailabs/contexto.git` (4 files) * `cd ekai-gateway` → `cd contexto` (4 files) * `npm install` / `npm run X` / `npm add X` / `npm run start -w @ekai/memory` → corresponding `pnpm` forms * `docs/intro.md` GitHub badge URL updated to point at the `ekailabs/contexto` repo Intentionally left as-is (out of scope per the issue): * "Ekai Gateway" product name in prose * `ekai-gateway-runtime` Docker compose stage name * `ghcr.io/ekailabs/ekai-gateway` published image refs * The `@ekai/memory` package name (it's a package import, not a repo path) Closes #135. --- docs/ROFL_DEPLOYMENT.md | 4 ++-- docs/USAGE_WITH_CLAUDE_CODE.md | 10 +++++----- docs/USAGE_WITH_CODEX.md | 10 +++++----- docs/getting-started.md | 10 +++++----- docs/intro.md | 2 +- docs/memory-plugin.md | 4 ++-- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/ROFL_DEPLOYMENT.md b/docs/ROFL_DEPLOYMENT.md index 325452b..2ffdc53 100644 --- a/docs/ROFL_DEPLOYMENT.md +++ b/docs/ROFL_DEPLOYMENT.md @@ -42,8 +42,8 @@ Deploy your own private ekai-gateway instance on Oasis Network using ROFL (Runti ```bash # 1. Clone -git clone https://github.com/ekailabs/ekai-gateway.git -cd ekai-gateway +git clone https://github.com/ekailabs/contexto.git +cd contexto # 2. Create rofl.yaml from template cp rofl.yaml.template rofl.yaml diff --git a/docs/USAGE_WITH_CLAUDE_CODE.md b/docs/USAGE_WITH_CLAUDE_CODE.md index ff939b2..1197d8a 100644 --- a/docs/USAGE_WITH_CLAUDE_CODE.md +++ b/docs/USAGE_WITH_CLAUDE_CODE.md @@ -14,10 +14,10 @@ This guide shows how to run Claude Code through ekai-gateway for multi‑provide ## Install and Run the Gateway ```bash -git clone https://github.com/ekailabs/ekai-gateway.git -cd ekai-gateway -npm install -npm run dev +git clone https://github.com/ekailabs/contexto.git +cd contexto +pnpm install +pnpm run dev ``` ## Configure Environment @@ -60,5 +60,5 @@ Notes ## Troubleshooting - 401/403 errors: verify the relevant API key is present in `.env` and the provider allows the chosen model. -- Connection refused: ensure `npm run dev` is active and `ANTHROPIC_BASE_URL` matches the gateway port. +- Connection refused: ensure `pnpm run dev` is active and `ANTHROPIC_BASE_URL` matches the gateway port. - Model not found: confirm the model name is supported by its provider and spelled correctly. diff --git a/docs/USAGE_WITH_CODEX.md b/docs/USAGE_WITH_CODEX.md index f0409e6..94b8f9b 100644 --- a/docs/USAGE_WITH_CODEX.md +++ b/docs/USAGE_WITH_CODEX.md @@ -14,10 +14,10 @@ This guide walks through configuring Codex to use ekai-gateway for unified multi ## Install and Run the Gateway ```bash -git clone https://github.com/ekailabs/ekai-gateway.git -cd ekai-gateway -npm install -npm run dev +git clone https://github.com/ekailabs/contexto.git +cd contexto +pnpm install +pnpm run dev ``` ## Configure Environment @@ -75,4 +75,4 @@ codex --model "claude-sonnet-4-20250514" ## Troubleshooting - 401/403 errors: ensure the corresponding provider API key is set in `.env` and has access to the selected model. - 404/Model not found: confirm the model name is supported and correctly spelled. -- Network errors: verify `npm run dev` is running and `OPENAI_BASE_URL`/`base_url` points to the correct port. +- Network errors: verify `pnpm run dev` is running and `OPENAI_BASE_URL`/`base_url` points to the correct port. diff --git a/docs/getting-started.md b/docs/getting-started.md index 2c56a95..511a185 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -18,13 +18,13 @@ This is a quick-start for running Ekai Gateway locally. For detailed client setu 1. Clone the repository ```bash - git clone https://github.com/ekailabs/ekai-gateway.git - cd ekai-gateway + git clone https://github.com/ekailabs/contexto.git + cd contexto ``` 2. Install dependencies ```bash - npm install + pnpm install ``` 3. Copy and edit the environment file @@ -42,8 +42,8 @@ This is a quick-start for running Ekai Gateway locally. For detailed client setu 4. Build and start the Gateway ```bash - npm run build - npm start + pnpm run build + pnpm start ``` After startup: diff --git a/docs/intro.md b/docs/intro.md index 21c9731..077cafb 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -2,7 +2,7 @@ > Ekai is the universal context layer for agentic AI. Below you’ll find quick links to get started and learn more. -[![GitHub - ekailabs/ekai-gateway](https://img.shields.io/badge/GitHub-ekailabs%2Fekai--gateway-181717?logo=github&logoColor=white)](https://github.com/ekailabs/ekai-gateway) +[![GitHub - ekailabs/contexto](https://img.shields.io/badge/GitHub-ekailabs%2Fcontexto-181717?logo=github&logoColor=white)](https://github.com/ekailabs/contexto) - [Getting Started](getting-started.md) - [Architecture Overview](architecture-overview.md) diff --git a/docs/memory-plugin.md b/docs/memory-plugin.md index c849819..184fb64 100644 --- a/docs/memory-plugin.md +++ b/docs/memory-plugin.md @@ -18,7 +18,7 @@ Both use the same `@ekai/memory` engine underneath. ### Install ```bash -npm install @ekai/memory +pnpm add @ekai/memory ``` ### SDK Quickstart @@ -67,7 +67,7 @@ app.use(createMemoryRouter(memory._store, memory._extractFn)); Run memory as its own HTTP service: ```bash -npm run start -w @ekai/memory +pnpm --filter @ekai/memory run start # Memory service listening on :4005 ```