fix(readme): correct npm install command + remove stale internal-runbook links#1
Merged
Merged
Conversation
…ook links Two small README cleanups: 1. The install matrix listed `npm install -g kaizen-cli`, but the published npm package (matching the PyPI and Homebrew naming) is `kaizen-3c-cli`. Anyone copy-pasting the previous command would hit a 404 from the npm registry. Updated to `npm install -g kaizen-3c-cli`. 2. The "Release process" section linked to two internal maintainer docs that exist in the private upstream repo but not in this public one: `docs/release/RELEASE_PROCESS.md` and `docs/release/PUBLIC_REPO_ALLOWLIST.md`. Both links 404 on GitHub. Removed the section entirely — public OSS users don't need to see the internal release process; advertising dead links is worse than omitting the explanation. No functional changes; no API or CLI behavior changes. Only README edits. Signed-off-by: anthonyadame <anthonyadame@gmail.com>
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
1 participant
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.
Summary
Two small README fixes:
npm install -g kaizen-cli→npm install -g kaizen-3c-cli(line 15). The npm package is published askaizen-3c-clito match the PyPI name; the README was showing the wrong name.docs/release/RELEASE_PROCESS.mdanddocs/release/PUBLIC_REPO_ALLOWLIST.md. Those files live in an internal repo and 404 from this public README.Test plan
grep -n 'npm install -g kaizen-cli\b' README.md→ empty (onlykaizen-3c-cliremains)grep -n 'docs/release/' README.md→ emptygrep -n '### Release process' README.md→ empty