Skip to content

Add upgrade guides for StudioCMS v0.4.1 and v0.4.2#237

Merged
Adammatthiesen merged 3 commits into
mainfrom
adam/0.4.1
Mar 10, 2026
Merged

Add upgrade guides for StudioCMS v0.4.1 and v0.4.2#237
Adammatthiesen merged 3 commits into
mainfrom
adam/0.4.1

Conversation

@Adammatthiesen
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen commented Mar 10, 2026

This pull request adds upgrade guides for StudioCMS versions v0.4.1 and v0.4.2, and makes a minor edit to the v0.4.0 guide. The new guides include important compatibility notes regarding Astro v6 and document bug fixes and improvements for each release.

New upgrade guides:

  • Added src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx for StudioCMS v0.4.1, including a note about Astro v6 compatibility and a fix for Analytics plugin import resolution errors.
  • Added src/content/docs/en/guides/upgrade/version-guides/0-4-2.mdx for StudioCMS v0.4.2, featuring a note about Astro v6 compatibility and a fix for bundling effect dependencies to resolve CJS/ESM issues.

Documentation updates:

  • Removed the "NEW" badge from the sidebar of the v0.4.0 upgrade guide in src/content/docs/en/guides/upgrade/version-guides/0-4-0.mdx for consistency with newer guides.

Summary by CodeRabbit

  • Documentation

    • Added upgrade guide for v0.4.1 with Astro v6 compatibility note.
    • Added upgrade guide for v0.4.2 with upgrade details and compatibility notes.
    • Removed a "NEW" badge from the v0.4.0 upgrade guide to clean up sidebar display.
  • Bug Fixes

    • Fixed import resolution for the optional Analytics plugin to prevent errors when enabled/disabled.
    • Fixed bundling of an effect and its dependencies to ensure proper ESM packaging.

@htg-1-studiocms-cloud
Copy link
Copy Markdown

htg-1-studiocms-cloud Bot commented Mar 10, 2026

Dokploy Preview Deployment

Name Status Preview Updated (UTC)
StudioCMS Docs ✅ Done Preview URL 2026-03-10T09:48:04.161Z

@Adammatthiesen Adammatthiesen marked this pull request as ready for review March 10, 2026 05:38
@Adammatthiesen Adammatthiesen requested a review from a team as a code owner March 10, 2026 05:38
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 10, 2026

📝 Walkthrough

Walkthrough

Removed the frontmatter "NEW" badge from the v0.4.0 upgrade guide and added new v0.4.1 and v0.4.2 upgrade guide MDX pages documenting small bug-fix notes and Astro v6 compatibility hints.

Changes

Cohort / File(s) Summary
Upgrade Guides
src/content/docs/en/guides/upgrade/version-guides/0-4-0.mdx, src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx, src/content/docs/en/guides/upgrade/version-guides/0-4-2.mdx
Removed badge: { text: NEW, variant: success } from v0.4.0 frontmatter; added v0.4.1 and v0.4.2 guide pages with frontmatter, imported components (QuickUpdate, Aside), QuickUpdate blocks, Astro v6 compatibility notes, and bug-fix descriptions (Analytics plugin import resolution and Vite optimizeDeps change for Effect bundling).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • dreyfus92
  • RATIU5

Poem

🐰 I hopped through frontmatter, light and spry,
Nudged a badge away with a wink of my eye.
New guides planted, small fixes in tow,
I nibble on docs as the updates grow —
Hooray for tidy changelogs! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly describes the main changes: adding upgrade guides for v0.4.1 and v0.4.2, which aligns with the PR summary that documents the new guides and updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch adam/0.4.1

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Mar 10, 2026

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/upgrade/version-guides/0-4-0.mdx Source changed, localizations will be marked as outdated.
en/guides/upgrade/version-guides/0-4-1.mdx Localization added, will be marked as complete.
en/guides/upgrade/version-guides/0-4-2.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@coderabbitai coderabbitai Bot added the i18n label Mar 10, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx`:
- Line 16: Remove the unused import ReadMore from the MDX file by deleting the
import statement that references ReadMore (import ReadMore from
'~/components/ReadMore.astro';) so there are no unused symbols; locate the
import at the top of the document and remove it to eliminate the unused-import
warning.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 439a09a7-f79b-4abc-8096-7143a4973968

📥 Commits

Reviewing files that changed from the base of the PR and between f3b9595 and dbe0cd5.

📒 Files selected for processing (2)
  • src/content/docs/en/guides/upgrade/version-guides/0-4-0.mdx
  • src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx
💤 Files with no reviewable changes (1)
  • src/content/docs/en/guides/upgrade/version-guides/0-4-0.mdx

Comment thread src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx Outdated
@Adammatthiesen Adammatthiesen changed the title Add upgrade guide for StudioCMS v0.4.1 with bug fixes and improvements Add upgrade guides for StudioCMS v0.4.1 and v0.4.2 Mar 10, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx`:
- Around line 16-17: Replace the time-sensitive text inside the Aside component
(Aside variant="note" title='Note About Astro v6') with a stable, version-scoped
statement that says v0.4.1 is not compatible with Astro v6 yet and that users
should not upgrade to Astro v6 if they need compatibility with StudioCMS v0.4.1;
remove words like "recently" and "within a few weeks" and instead point readers
to the compatibility or release notes page for future updates and guidance.

In `@src/content/docs/en/guides/upgrade/version-guides/0-4-2.mdx`:
- Around line 23-24: Update the bullet to fix grammar and consistent package
naming: change "it's" to "its", rephrase "it is ESM version" to "its ESM build"
(or "its ESM version") for clarity, and use a single consistent casing for the
package name (choose either "effect" or "Effect" and apply it throughout);
ensure the sentence mentions adding the package to the Vite optimizeDeps
configuration so the ESM build is properly bundled for StudioCMS.
- Around line 19-20: Update the Aside block (Aside variant="note" title='Note
About Astro v6') to remove time-relative wording ("recently released", "within a
few weeks") and instead state version-scoped compatibility: explicitly say that
v0.4.2 is not compatible with Astro v6 and that users should not upgrade to
Astro v6 until a future StudioCMS release adds compatibility; keep the
recommendation to wait but avoid any time estimates and remove predictive
language.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0f59ddc0-ec96-42fa-8106-784f7bd33924

📥 Commits

Reviewing files that changed from the base of the PR and between 50601f3 and b8e7084.

📒 Files selected for processing (2)
  • src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx
  • src/content/docs/en/guides/upgrade/version-guides/0-4-2.mdx

Comment thread src/content/docs/en/guides/upgrade/version-guides/0-4-1.mdx
Comment thread src/content/docs/en/guides/upgrade/version-guides/0-4-2.mdx
Comment thread src/content/docs/en/guides/upgrade/version-guides/0-4-2.mdx
@Adammatthiesen Adammatthiesen merged commit 02ebf80 into main Mar 10, 2026
8 checks passed
@Adammatthiesen Adammatthiesen deleted the adam/0.4.1 branch March 10, 2026 10:09
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants