Updated docs for public adapter base packages - #29556
Conversation
no ref - update README documentation for published packages with usage + other info
WalkthroughExpanded the cache, scheduling, SSO, and storage adapter READMEs with implementation examples, required methods, installation steps, and Ghost activation configuration. Revised ESM and TypeScript build guidance by removing prior module-resolution and CommonJS compatibility details. Added Changesets metadata for patch updates to four adapter-related packages and recorded the documentation changes. Possibly related PRs
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 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 |
|
| Command | Status | Duration | Result |
|---|---|---|---|
nx run-many -t test:unit -p @tryghost/adapter-b... |
✅ Succeeded | 33s | View ↗ |
nx run ghost-monorepo:lint:boundaries |
✅ Succeeded | <1s | View ↗ |
nx run-many -t lint -p ghost-monorepo,@tryghost... |
✅ Succeeded | 26s | View ↗ |
nx run @tryghost/admin:build |
✅ Succeeded | 9s | View ↗ |
nx run-many --target=build --projects=tag:publi... |
✅ Succeeded | <1s | View ↗ |
💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗
☁️ Nx Cloud last updated this comment at 2026-07-23 10:45:42 UTC
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/adapters/cache-base/README.md`:
- Around line 12-16: Replace the npm installation command with pnpm add in
packages/adapters/cache-base/README.md lines 12-16,
packages/adapters/scheduling-base/README.md lines 13-17,
packages/adapters/sso-base/README.md lines 12-16, and
packages/adapters/storage-base/README.md lines 12-16, preserving each package
name.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: b431be32-ea28-4866-9733-936a70dda31c
📒 Files selected for processing (7)
.changeset/major-areas-fail.mdpackages/adapters/cache-base/LICENSEpackages/adapters/cache-base/README.mdpackages/adapters/scheduling-base/README.mdpackages/adapters/sso-base/README.mdpackages/adapters/storage-base/LICENSEpackages/adapters/storage-base/README.md
💤 Files with no reviewable changes (2)
- packages/adapters/storage-base/LICENSE
- packages/adapters/cache-base/LICENSE

no ref
pnpm publishships the root one automatically)