Skip to content

add beta.20 guide#142

Merged
Adammatthiesen merged 1 commit into
mainfrom
beta.20
Jul 22, 2025
Merged

add beta.20 guide#142
Adammatthiesen merged 1 commit into
mainfrom
beta.20

Conversation

@Adammatthiesen
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen commented Jul 22, 2025

Description

  • Closes #
  • What does this PR change? Give us a brief description.

Add guide for new beta.20 version

Summary by CodeRabbit

  • New Features

    • Added a new upgrade guide for version 0.1.0-beta.20, including details on a bug fix and an important note about password hashing changes.
  • Chores

    • Updated project dependencies.
    • Removed the "NEW" badge from the upgrade guide for version 0.1.0-beta.19.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 22, 2025

Walkthrough

This update removes the "NEW" badge from the upgrade guide for version 0.1.0-beta.19, adds a new upgrade guide for version 0.1.0-beta.20 with a "NEW" badge and content about bug fixes and breaking changes, and updates the studiocms subproject reference to a newer commit.

Changes

File(s) Change Summary
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-19.mdx Removed "NEW" badge from sidebar metadata.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx Added new upgrade guide for version 0.1.0-beta.20, including metadata, badges, and content.
studiocms Updated subproject reference to a newer commit.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    participant StudioCMS

    User->>Docs: Access upgrade guide for 0.1.0-beta-20
    Docs->>StudioCMS: Reference new subproject commit
    Docs-->>User: Display guide with bug fix and breaking change note
Loading

Estimated code review effort

1 (~3 minutes)

Possibly related PRs

Suggested reviewers

  • dreyfus92

Poem

A badge is gone, another appears,
New guides bloom as the version clears.
Bugs are fixed and passwords change,
Docs and code in tidy range.
With every hop, the docs grow bright—
A rabbit’s joy in versioned light! 🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@studiocms-no-reply
Copy link
Copy Markdown
Member

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-1-0-beta-19.mdx Source changed, localizations will be marked as outdated.
en/guides/upgrade/version-guides/0-1-0-beta-20.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.

@Adammatthiesen Adammatthiesen marked this pull request as ready for review July 22, 2025 04:18
@Adammatthiesen Adammatthiesen requested a review from a team as a code owner July 22, 2025 04:18
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: 0

🧹 Nitpick comments (3)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (3)

21-21: Fix article misuse & reduce repetition in bug-fix sentence

“a unavailable” → “an unavailable”, and “First time setup” is repeated three times.

- - Fixed First time setup routes that used a unavailable middleware feature during first time setup, causing the first time setup to fail.
+ - Fixed first-time setup routes that used an unavailable middleware feature, causing the initial setup to fail.

23-25: Clarify breaking-change note & add forward reference

Consider adding a link to the beta 16 release notes (or upgrade guide) so readers can easily review the original hashing-algorithm change.

-Please note that in `beta.16` we introduced a breaking change with the password hashing algorithm.
+In `beta.16`, we introduced a breaking change to the password-hashing algorithm ([see details](../0-1-0-beta-16)).

27-32: Remove or use orphaned link references

The footnote references ([config-doc], [image-service], etc.) are declared but never used in this document, which creates dead weight and potential confusion for translators and link checkers.

If they are not needed here, delete lines 27-32; otherwise, add in-text links that make use of them.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7be1157 and 5388b91.

📒 Files selected for processing (3)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-19.mdx (0 hunks)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1 hunks)
  • studiocms (1 hunks)
🧠 Learnings (3)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
studiocms (1)

Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.

src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1)

Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.

💤 Files with no reviewable changes (1)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-19.mdx
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
studiocms (1)

Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.

src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1)

Learnt from: ArmandPhilippot
PR: #140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.

🔇 Additional comments (2)
studiocms (1)

1-1: Confirm submodule commit availability & sync with beta .20 docs

The pointer now targets 029a22ddc227211ac71c7bda565b31b30c90a361.
Please verify that:

• The commit exists on the upstream studiocms repo (not a local/ephemeral branch).
• A fresh git clone --recursive correctly fetches this commit.
• The commit indeed contains the beta-20 assets referenced in the newly-added guide.

Once validated, no further action is needed.

src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1)

13-18: Verify QuickUpdate component availability

<QuickUpdate /> is imported but not present in other upgrade guides. Ensure the component exists at ~/components/QuickUpdate.astro; otherwise the build will fail.

If it’s missing, either create the component or replace it with ordinary markdown.

@Adammatthiesen Adammatthiesen merged commit a96aa4a into main Jul 22, 2025
8 checks passed
@Adammatthiesen Adammatthiesen deleted the beta.20 branch July 22, 2025 04:24
@coderabbitai coderabbitai Bot mentioned this pull request Jul 23, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 24, 2025
dreyfus92 added a commit that referenced this pull request Jul 25, 2025
See #142 and #146

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
@coderabbitai coderabbitai Bot mentioned this pull request Aug 11, 2025
1 task
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