docs: normalize clone URL and package manager to repo's current shape#148
Open
Chen17-sq wants to merge 1 commit into
Open
docs: normalize clone URL and package manager to repo's current shape#148Chen17-sq wants to merge 1 commit into
Chen17-sq wants to merge 1 commit into
Conversation
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.
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.
Linked issue
Closes #135.
Summary
Several user-facing docs still tell readers to
git clone ekailabs/ekai-gatewayand runnpm install, whileCONTRIBUTING.mddocuments apnpmworkspace flow. The repo's canonical name is nowekailabs/contexto; this PR updates the docs to match without touching anything the issue called out as out-of-scope.Changes
docs/getting-started.mdcontexto,cd ekai-gateway→cd contexto,npm install/npm run build/npm start→pnpmequivalentsdocs/USAGE_WITH_CLAUDE_CODE.mdcd+ 2×npm→pnpm(incl. troubleshooting line)docs/USAGE_WITH_CODEX.mdcd+ 2×npm→pnpm(incl. troubleshooting line)docs/ROFL_DEPLOYMENT.mdcddocs/intro.mdekailabs/contexto(URL + label)docs/memory-plugin.mdnpm install @ekai/memory→pnpm add @ekai/memory;npm run start -w @ekai/memory→pnpm --filter @ekai/memory run startDiff: 6 files, +20/-20.
Intentionally left as-is
Per the "Out of scope" section of issue #135:
docs/USAGE_WITH_CODEX.md:3,docs/ROFL_DEPLOYMENT.md:3,docs/USAGE_WITH_CLAUDE_CODE.md:3,40)ekai-gateway-runtimeDocker compose stage name (docs/getting-started.md:66)ghcr.io/ekailabs/ekai-gatewaypublished image and local Docker tag references@ekai/memorypackage name (it's a package import, not a repo path)package.jsonis still namedekai-gateway— out of scope per the issue ("worth a separate ticket")Verification