⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@Adammatthiesen
Copy link
Member

@Adammatthiesen Adammatthiesen commented Feb 6, 2026

This pull request adds documentation for upgrading StudioCMS to v0.3.0, removes references to deprecated virtual modules, and updates the upgrade guides. The changes focus on improving documentation clarity and accuracy, as well as reflecting recent codebase updates and breaking changes.

Documentation updates:

  • Added a new upgrade guide for StudioCMS v0.3.0, including breaking changes, bug fixes, and improvements. This guide highlights the removal of deprecated virtual modules, dependency updates, and fixes for client-side validation and route rendering. (src/content/docs/en/guides/upgrade/version-guides/0-3-0.mdx)
  • Updated the "How it works" documentation to remove references to the deprecated virtual module studiocms:auth/utils/getLabelForPermissionLevel. (src/content/docs/en/how-it-works/index.mdx)

Upgrade guide maintenance:

  • Cleaned up the v0.2.0 upgrade guide by removing the sidebar badge marking it as "NEW", reflecting its now-outdated status. (src/content/docs/en/guides/upgrade/version-guides/0-2-0.mdx)

Summary by CodeRabbit

  • Documentation
    • Added v0.3.0 upgrade guide detailing breaking changes and improvements, including CLI updates, dependency changes, and frontend validation enhancements.
    • Removed deprecated authentication utility reference from documentation.
    • Updated metadata for v0.2.0 upgrade guide.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 6, 2026

Warning

Rate limit exceeded

@Adammatthiesen has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 21 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Documentation updates removing a badge from an existing upgrade guide (0-2-0), adding a new v0.3.0 upgrade guide documenting breaking changes and improvements, and removing a deprecated authentication utility reference.

Changes

Cohort / File(s) Summary
Upgrade Version Guides
src/content/docs/en/guides/upgrade/version-guides/0-2-0.mdx, src/content/docs/en/guides/upgrade/version-guides/0-3-0.mdx
Removed "NEW" badge from 0-2-0 frontmatter; created new 0-3-0 guide documenting breaking changes (deprecated virtual modules) and bug fixes (chalk replacement, dependency updates, slug validation, email verification removal, 404 route fix).
Virtual Modules Documentation
src/content/docs/en/how-it-works/index.mdx
Removed deprecated studiocms:auth/utils/getLabelForPermissionLevel entry from authentication virtual modules reference list.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #212 — Modifies the same file (0-2-0.mdx) removing the identical badge frontmatter entry.
  • PR #199 — Removes badge from upgrade guide frontmatter in localized documentation using the same pattern.
  • PR #160 — Updates authentication virtual modules documentation and frontmatter badges in related contexts.

Suggested labels

i18n

Suggested reviewers

  • dreyfus92
  • RATIU5
  • louisescher

Poem

🐰 A badge bid farewell with a hop and a bound,
New guides for v0-3-0 now grace this ground,
Deprecated modules fade from sight,
Documentation shines ever bright! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding a new upgrade guide for v0.3.0 that documents breaking changes and improvements, which aligns with the primary file addition and purpose outlined in the PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch adam/v0.3

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
Member

studiocms-no-reply commented Feb 6, 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-2-0.mdx Source changed, localizations will be marked as outdated.
en/guides/upgrade/version-guides/0-3-0.mdx Localization added, will be marked as complete.
en/how-it-works/index.mdx Source changed, localizations will be marked as outdated.
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.

@Adammatthiesen Adammatthiesen marked this pull request as ready for review February 6, 2026 05:43
@Adammatthiesen Adammatthiesen requested a review from a team as a code owner February 6, 2026 05:43
@coderabbitai coderabbitai bot added the i18n label Feb 6, 2026
Copy link
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

🤖 Fix all issues with AI agents
In `@src/content/docs/en/guides/upgrade/version-guides/0-3-0.mdx`:
- Around line 27-32: The changelog bullet list has inconsistent capitalization
and verb forms; update the list entries so each starts with an uppercase verb
and uses a consistent tense/form (e.g., change "updates" to "Updates" and change
"Fix" to "Fixes") for the items that currently read "updates" and "Fix" in the
list containing "Replaces `chalk`...", "updates StudioCMS dependencies", "Fixes
issue with `pg`...", "Fix client regex...", "Removes legacy...", "Fixes default
404 route..."; ensure all bullets follow the same style (Prefer: "Replaces",
"Updates", "Fixes", "Fixes", "Removes", "Fixes").

@Adammatthiesen Adammatthiesen merged commit ef8315b into main Feb 7, 2026
9 checks passed
@Adammatthiesen Adammatthiesen deleted the adam/v0.3 branch February 7, 2026 11:03
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Feb 9, 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