Skip to content

docs: normalize clone URL and package manager to repo's current shape#148

Open
Chen17-sq wants to merge 1 commit into
ekailabs:mainfrom
Chen17-sq:docs/135-normalize-repo-name-and-pkg-manager
Open

docs: normalize clone URL and package manager to repo's current shape#148
Chen17-sq wants to merge 1 commit into
ekailabs:mainfrom
Chen17-sq:docs/135-normalize-repo-name-and-pkg-manager

Conversation

@Chen17-sq
Copy link
Copy Markdown

Linked issue

Closes #135.

Summary

Several user-facing docs still tell readers to git clone ekailabs/ekai-gateway and run npm install, while CONTRIBUTING.md documents a pnpm workspace flow. The repo's canonical name is now ekailabs/contexto; this PR updates the docs to match without touching anything the issue called out as out-of-scope.

Changes

File What changed
docs/getting-started.md clone URL → contexto, cd ekai-gatewaycd contexto, npm install/npm run build/npm startpnpm equivalents
docs/USAGE_WITH_CLAUDE_CODE.md clone URL + cd + 2× npmpnpm (incl. troubleshooting line)
docs/USAGE_WITH_CODEX.md clone URL + cd + 2× npmpnpm (incl. troubleshooting line)
docs/ROFL_DEPLOYMENT.md clone URL + cd
docs/intro.md GitHub badge points at ekailabs/contexto (URL + label)
docs/memory-plugin.md npm install @ekai/memorypnpm add @ekai/memory; npm run start -w @ekai/memorypnpm --filter @ekai/memory run start

Diff: 6 files, +20/-20.

Intentionally left as-is

Per the "Out of scope" section of issue #135:

  • "Ekai Gateway" product name in prose (e.g. docs/USAGE_WITH_CODEX.md:3, docs/ROFL_DEPLOYMENT.md:3, docs/USAGE_WITH_CLAUDE_CODE.md:3,40)
  • ekai-gateway-runtime Docker compose stage name (docs/getting-started.md:66)
  • ghcr.io/ekailabs/ekai-gateway published image and local Docker tag references
  • The @ekai/memory package name (it's a package import, not a repo path)
  • Root package.json is still named ekai-gateway — out of scope per the issue ("worth a separate ticket")

Verification

# Confirm no `npm install / npm run / npm add / ekailabs/ekai-gateway` strings
# remain in the touched docs (word-boundary regex to avoid matching `pnpm`):
$ grep -nE '(^|[^p])npm install|(^|[^p])npm run|(^|[^p])npm add|ekailabs/ekai-gateway' \
    docs/getting-started.md docs/USAGE_WITH_CODEX.md docs/USAGE_WITH_CLAUDE_CODE.md \
    docs/ROFL_DEPLOYMENT.md docs/intro.md docs/memory-plugin.md | grep -v '@ekai/memory'
# (empty — clean)

# Remaining `ekai-gateway` mentions are exactly the prose / compose-stage refs
# the issue listed as out-of-scope.

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 ekailabs#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 ekailabs#135.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Normalize docs to current repo name and package manager

1 participant