Repository navigation
docs: name the hosted service CacheKit Cloud and state shipped defaults (LAB-12494) - #229
Conversation
Adds a no-retired-names pre-commit hook that rejects retired product names and wrong package names in READMEs, docs and llms.txt.
Findings
|
| Layer / File(s) | Summary |
|---|---|
Update CacheKit Cloud labels README.md, conformance/README.md |
The README replaces SaaS API labels with CacheKit Cloud API labels. The conformance README replaces “CachekitIO service” with “CacheKit Cloud”. |
Add retired-name pre-commit check .pre-commit-config.yaml |
The new hook checks selected README files, docs/, and llms.txt for specified names, wording, and install commands. |
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Suggested reviewers: kodus-27b
Merge Risk: 
Low · up to 45505
-
The documentation hook can miss prohibited package targets, retired names, and wrapped phrases, but the fixes are localized and low risk.
Pre-merge checks: 
5
-
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)
-
Finishing Touches
-
Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Code Review Completed! 🔥The code review was successfully completed based on your current configurations. Kody Guide: Usage and ConfigurationInteracting with Kody
Providing Context (Files & MCPs)Add these hints in your PR description (or a comment) to unlock deeper checks:
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
Changes
spec/saas-api.mdfilename stays as a link target.conformance/README.md: theserverbinding is described as CacheKit Cloud.spec/,sdk-feature-matrix.md,decisions/andchangelog.d/are unchanged.Adds a
no-retired-namespre-commit hook next tono-internal-references, with the samefiles:scope plusllms.txt. It rejects retired names for the hosted service (it is "CacheKit Cloud" in prose;CachekitIOstays a code identifier), the retired tagline, "no backend required", and wrong package targets (cargo add cachekit,npm install cachekit,pip install cachekit-py).Naming rules: https://docs.cachekit.io/contributing/#names
Closes LAB-12494