docs: refresh published package READMEs after protectjs → stack rename#553
Merged
Conversation
- All READMEs: repository/license/star-badge URLs now point at cipherstash/stack - protect: replace 14 dead in-repo docs links with cipherstash.com/docs URLs (the docs/ tree was removed in def9f4b); pin the architecture diagram to a permalink of the last commit that contained it; add a tip pointing new projects at @cipherstash/stack - nextjs: rewrite README — it described the package as '@cipherstash/protect ... the main package' - schema, drizzle, protect-dynamodb: retitle away from Protect.js branding and add tips pointing at the @cipherstash/stack equivalents (encryptedTable/encryptedColumn, stack/drizzle, encryptedDynamoDB) - changeset: patch bumps so the corrected READMEs ship to npm
🦋 Changeset detectedLatest commit: d140575 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR refreshes package READMEs and a changeset after the protectjs → stack repository rename. It updates license links, package introductions, documentation URLs, and README guidance to point new projects toward ChangesREADME Documentation Refresh
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related issues
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/protect-dynamodb/README.md`:
- Line 10: The license badge in the README is pointing to the wrong package
name, so update the badge target to use `@cipherstash/protect-dynamodb` instead of
`@cipherstash/protect`. Make this change in the badge markup near the license
badge so the rendered metadata matches the documented package.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9c80f51f-47f0-4d2f-ad8a-5641606ab453
📒 Files selected for processing (8)
.changeset/refresh-package-readmes.mdpackages/cli/README.mdpackages/drizzle/README.mdpackages/nextjs/README.mdpackages/protect-dynamodb/README.mdpackages/protect/README.mdpackages/schema/README.mdpackages/stack/README.md
Contributor
Author
|
Docs/meta change. Low risk. |
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
Follow-up to #552 covering the READMEs that ship to npm. These still carried pre-rename content:
cipherstash/protectjs; nowcipherstash/stack.@cipherstash/protect— 14 links pointed at the in-repodocs/tree removed in def9f4b (broken both on GitHub and npm). Each is remapped to the equivalent cipherstash.com/docs page; the architecture diagram is pinned to a permalink of the last commit containing the image. Added a tip directing new projects to@cipherstash/stack.@cipherstash/nextjs— README was flat-out wrong ("This is the main package for the CipherStash Protect JavaScript Package"). Rewritten to describe what the package actually is, with the bundling caveat.@cipherstash/schema,@cipherstash/drizzle,@cipherstash/protect-dynamodb— retitled away from Protect.js branding, with tips pointing at the@cipherstash/stackequivalents. The legacycsTable/protect()API docs are left intact since those packages still export that API.Includes a patch changeset for the seven affected published packages so the corrected READMEs actually reach npm.
Notes
Protect.jsname is retained insidepackages/protect/README.mdbody copy — that package's identity is still Protect.js; only repo links and dead docs links changed there.Summary by CodeRabbit
@cipherstash/stack(legacy@cipherstash/protectis still documented).