chore: refresh root meta files after protectjs → stack rename#552
Conversation
- SECURITY.md: replace stale per-package version tables with a drift-proof support policy + current package list (adds stash CLI, migrate, prisma-next, wizard); fix scope (repo name, npm namespace); document the full supply-chain control set; fix typo - AGENTS.md: correct repo name, add missing packages (cli, wizard, migrate, prisma-next, bench), fix examples list, replace dead docs/* links with cipherstash.com/docs, add stash-cli skill, complete subpath export list - CONTRIBUTE.md: rewrite around @cipherstash/stack and cipherstash/stack (was still @cipherstash/protect + protectjs URLs + JSEQL naming) - package.json: rename root to @cipherstash/stack-monorepo, mark private, fix bugs/repository URLs - Delete .cursorrules (documented the pre-rename API; AGENTS.md is the single source for agent guidance now) - .cursor/commands/create-example-app.md: rebrand to stack, current API names and real CS_* env vars - docs-feedback issue template: point CoC link at cipherstash/stack
|
📝 WalkthroughWalkthroughThis PR updates repository documentation, contributor guidance, and package metadata to reference CipherStash Stack instead of Protect.js/protectjs. It also revises example-app prompting, security documentation, issue-template links, and root/package contact and repository fields. ChangesDocumentation and metadata rebrand
Estimated code review effort: 2 (Simple) | ~12 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
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 `@CONTRIBUTE.md`:
- Around line 15-27: The repo-tree fenced block in CONTRIBUTE.md is missing a
language tag, which triggers markdownlint-cli2 MD040. Update the existing fenced
block around the repository layout snippet to use a text/markdown-compatible
fence label while keeping the content unchanged; locate it by the tree diagram
under the main package description.
🪄 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: c9b5243a-a329-45bc-8795-6b664a77d31e
📒 Files selected for processing (7)
.cursor/commands/create-example-app.md.cursorrules.github/ISSUE_TEMPLATE/docs-feedback.ymlAGENTS.mdCONTRIBUTE.mdSECURITY.mdpackage.json
💤 Files with no reviewable changes (1)
- .cursorrules
There was a problem hiding this comment.
Pull request overview
Refreshes root-level meta/docs to reflect the repo rename to cipherstash/stack, the move of user docs to cipherstash.com/docs, and the expanded set of published packages in this monorepo.
Changes:
- Rewrote/updated
SECURITY.md,AGENTS.md, andCONTRIBUTE.mdto match current repo scope, package layout, and supply-chain controls. - Updated root
package.jsonmetadata for the renamed monorepo and prevented accidental publication via"private": true. - Rebranded Cursor command guidance and fixed the docs feedback issue template’s Code of Conduct link; removed stale
.cursorrules.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Replaces stale per-version support tables with a package list + “latest release line” policy; updates scope and documents supply-chain controls. |
| package.json | Renames the monorepo package metadata, updates GitHub URLs, and marks the root as private. |
| CONTRIBUTE.md | Updates contribution guidance to the Stack monorepo and links to AGENTS/SECURITY for deeper details. |
| AGENTS.md | Updates repo identity, layout, subpath exports list, and replaces in-repo docs links with docs-site URLs. |
| .github/ISSUE_TEMPLATE/docs-feedback.yml | Updates Code of Conduct link to the renamed repository. |
| .cursorrules | Deletes stale pre-rename Cursor rules. |
| .cursor/commands/create-example-app.md | Rebrands and updates example-app guidance for @cipherstash/stack and current env var names. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- AGENTS.md: bundling guidance was out of date — the WASM entry (@cipherstash/stack/wasm-inline) is designed to be bundled and is the answer for edge/serverless runtimes; native-FFI externalization only applies to the default entry - SECURITY.md: release.yml uses OIDC trusted publishing with NO NPM_TOKEN — previous text claimed the opposite - create-example-app.md: prefer 'npx stash auth login' profile auth for local dev; CS_* env vars are for CI/deployment - Replace hello@cipherstash.com with humans@cipherstash.com across the repo (root + 9 package.json author fields) - CONTRIBUTE.md: tag repo-tree fence as text (markdownlint MD040)
|
Docs/meta only. Low risk change. |
Summary
The root meta files never caught up with three changes: the repo rename (`cipherstash/protectjs` → `cipherstash/stack`), the removal of `docs/` in favour of cipherstash.com/docs, and the growth of the package set (cli, wizard, migrate, prisma-next, bench).
Root README.md deliberately untouched (being addressed in #526). Published package READMEs come in a follow-up PR since they ship to npm.
Validation
Summary by CodeRabbit
Closes #554