Beta.24 docs#158
Conversation
- Removed "Updated" badges from various documentation pages including features, upgrade guides, how it works, plugins, and getting started. - Added new constants `PLUGINS` and `MIDDLEWARES` to the SDKCoreJs import in the SDK documentation. - Changed the badge text and variant for the WYSIWYG plugin from "Experimental" to "Plugin" with a "tip" variant. - Updated subproject reference in the studiocms directory. - Added new upgrade guide for version 0.1.0-beta.24, detailing breaking changes and bug fixes.
✅ Deploy Preview for studiocms-dev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughMigrates Studiocms packages to private-registry pins (commit 853e6e6), updates/bumps various dependencies and tooling, adds a new 0.1.0-beta.24 upgrade guide, removes several docs sidebar badges, updates an SDK example to show PLUGINS and MIDDLEWARES, tweaks a plugin badge, and advances the studiocms submodule. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (1)
8-10: Minor frontmatter tidy-up: remove stray space after keyThere’s a trailing space after "badge:" which is inconsistent with surrounding keys.
- badge: + badge: text: 'Plugin' variant: 'tip'src/content/docs/en/how-it-works/sdk.mdx (2)
63-65: Confirm availability of new exports in the published SDKDocs now show PLUGINS and MIDDLEWARES on SDKCoreJs. Please verify these exports exist in the 853e6e6 build across all registries; otherwise examples will fail at build time.
Would you like me to add a short usage example for PLUGINS and MIDDLEWARES to make this section more actionable?
63-65: Optional: Add a quick usage snippet to anchor the new conceptsA terse example helps readers understand when to reach for these APIs.
Example snippet to add below the destructuring:
// Register or inspect plugins const allPlugins = SDKCoreJs.PLUGINS.list(); // Compose/request via middleware hooks const securedGetPages = SDKCoreJs.MIDDLEWARES.apply('auth', SDKCoreJs.GET.pages); const result = await runSDK(securedGetPages());src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-24.mdx (5)
21-21: Tighten phrasing for the breaking change bulletCurrent sentence repeats “as well”. Suggest clearer wording.
-- Adds new `StudioCMSPluginData` table to AstroDB for usage by StudioCMS plugins. As well as new SDK plugins utilities for dynamic table typing as well. +- Adds a new `StudioCMSPluginData` table to Astro DB for StudioCMS plugins. It also introduces new SDK plugin utilities for dynamic table typing.
23-25: Make the migration step explicit and easier to copyRecommend a code block and minor grammar improvements.
-When updating you will be required to run `astro db push --remote` with your package manager to update your table schema so that the table schema is updated before running the new version! +Before upgrading, run the following to update your remote table schema: + +```bash +pnpm astro db push --remote +# or: npm run astro db push -- --remote +# or: bunx astro db push --remote +```
31-31: Capitalize SDK and tighten wording-- Introduce new middlewares sdk module to ensure cache objects are initialized and not empty. +- Introduces a new Middleware SDK module to ensure cache objects are initialized and non-empty.
32-32: Name/style corrections: robots.txt and Zod-- Converts internal `robotstxt` to proper zod schema and cleans up related code. +- Converts internal `robots.txt` handling to a proper Zod schema and cleans up related code.
33-33: Grammar fix-- Updates editor page, to also inject a id variable for the current page. +- Updates the editor page to inject an id variable for the current page.package.json (1)
88-91: Lock Vite override exactly to reduce churnUsing a caret on an override can introduce surprise minor bumps. Suggest pinning to an exact version unless there’s a specific need for the range.
"pnpm": { "overrides": { - "vite": "^6.3.4" + "vite": "6.3.4" } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (11)
package.json(1 hunks)src/content/docs/en/config-reference/features.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-23.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-24.mdx(1 hunks)src/content/docs/en/how-it-works/index.mdx(0 hunks)src/content/docs/en/how-it-works/sdk.mdx(1 hunks)src/content/docs/en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx(1 hunks)src/content/docs/en/plugins/index.mdx(0 hunks)src/content/docs/en/start-here/getting-started.mdx(0 hunks)src/content/docs/en/utils/rendering.mdx(0 hunks)studiocms(1 hunks)
💤 Files with no reviewable changes (6)
- src/content/docs/en/how-it-works/index.mdx
- src/content/docs/en/utils/rendering.mdx
- src/content/docs/en/config-reference/features.mdx
- src/content/docs/en/start-here/getting-started.mdx
- src/content/docs/en/plugins/index.mdx
- src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-23.mdx
🔇 Additional comments (6)
studiocms (2)
1-1: LGTM: submodule advanced to 853e6e6 for beta.24 alignmentPointer update looks good and matches the PR intent to align the studiocms subproject with beta.24.
1-1: Submodule pointer consistency verifiedAll references to the studiocms submodule—gitlink (mode 160000, commit 853e6e668b46eaa2808e7fcdf4ff4039de3a596d),
.gitmodulesURL, package.json entries, and pnpm-lock.yaml resolutions—consistently use commit 853e6e6. No updates are needed.src/content/docs/en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (1)
9-10: Badge update looks correctChanging the badge to Plugin/tip aligns with the stated PR objective and taxonomy.
package.json (3)
25-33: Private registry URLs look consistent; confirm CI auth & intentional hashes
- All
@studiocms/*dependencies are pinned to the same commit (853e6e6), so there’s no API-drift risk among them.- There is also a
@lunariajs/coreentry at commit4c8b9b0– please verify that pin is intentional.- Ensure your CI (and any local
.npmrc) is configured to authenticate againstpkg.pr.newso installs won’t fail.No code changes needed if auth is in place and the extra pin is deliberate.
44-45: Versions confirmed on npmBoth specified dependency versions are published and available:
- typescript ^5.8.3 exists (latest stable is 5.9.2)
- astro-integration-kit ^0.18.0 is the current release
No further action needed.
37-41: Compatibility matrix check ✅
I’ve reviewed the npm metadata for the bumped packages:
- @astrojs/starlight@0.35.2
- @astrojs/node@9.3.1
- @astrojs/react@4.3.0
None of these declare any
peerDependenciesorenginesconstraints, so upgrading to Astro ^5.12.9 and @astrojs/db ^0.17.1 does not introduce hidden version requirements.• If you have a custom Vite override in your
astro.config.*, please ensure it remains compatible with the Vite version bundled in Astro 5.
Co-authored-by: Louis Escher <66965600+louisescher@users.noreply.github.com>
4 participants
TODO before merge
Changes
PLUGINSandMIDDLEWARESto the SDKCoreJs import in the SDK documentation.Summary by CodeRabbit
Documentation
Chores