Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

docs: fix README inconsistencies and outdated info#5

Merged
NicolasRitouet merged 1 commit intomainfrom
docs/fix-readme-inconsistencies
Jan 21, 2026
Merged

docs: fix README inconsistencies and outdated info#5
NicolasRitouet merged 1 commit intomainfrom
docs/fix-readme-inconsistencies

Conversation

@NicolasRitouet
Copy link
Copy Markdown
Member

@NicolasRitouet NicolasRitouet commented Jan 21, 2026

Summary

  • Fix install URL: https://get.keyway.shhttps://keyway.sh/install.sh
  • Fix flag: --env-e
  • Remove non-existent --ci flag reference
  • Fix example: keyway pull --env productionkeyway pull -e production

Test plan

  • Verify install URL works
  • Verify examples are accurate

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated installation script URL for streamlined setup.
    • Simplified command-line syntax with shorter flag options.
    • Updated authentication guidance to use Dashboard API Keys instead of CLI-based login.
    • Updated GitHub Actions workflow examples with new command syntax.

✏️ Tip: You can customize this high-level summary in your review settings.

- Fix install URL: https://get.keyway.shhttps://keyway.sh/install.sh
- Fix flag: --env → -e
- Remove non-existent --ci flag reference
- Fix example: keyway pull --env production → keyway pull -e production

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 21, 2026

📝 Walkthrough

Walkthrough

Documentation updates across README files include: installation script URL changes (https://get.keyway.sh to https://keyway.sh/install.sh), environment flag shortening (--env to -e), and KEYWAY_TOKEN description clarifications referencing Dashboard API Keys creation instead of CLI login instructions.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md, npm/README.md
Install script URL updated; command flags shortened from --env production to -e production in multiple examples (zero-trust run, GitHub Actions); KEYWAY_TOKEN description updated to reference Dashboard API Keys creation instead of CLI login method

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 The docs hop with joy, so fresh and bright,
New URLs and flags, all set just right,
Dashboard API Keys now light the way,
Shorter commands to code and play! 🚀✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change in the changeset—fixing README documentation inconsistencies (URLs, flags, and outdated information) across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 21, 2026

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@NicolasRitouet NicolasRitouet merged commit b9ca86e into main Jan 21, 2026
10 checks passed
@NicolasRitouet NicolasRitouet deleted the docs/fix-readme-inconsistencies branch January 21, 2026 08:28
@coderabbitai coderabbitai Bot mentioned this pull request Feb 6, 2026
3 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant