Skip to content

Update docs for Beta.19 update#139

Merged
Adammatthiesen merged 27 commits into
mainfrom
beta.19-update
Jul 20, 2025
Merged

Update docs for Beta.19 update#139
Adammatthiesen merged 27 commits into
mainfrom
beta.19-update

Conversation

@Adammatthiesen
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen commented Jul 18, 2025

This PR is ready to be reviewed but the following changes will need to be done before final merging after release of beta.19:

  • Update the following to true
  • Update package.json to use real versions instead of snapshot

    docs/package.json

    Lines 25 to 30 in bad3dc9

    "studiocms": "https://pkg.pr.new/withstudiocms/studiocms@594",
    "@studiocms/blog": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/blog@594",
    "@studiocms/devapps": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/devapps@594",
    "@studiocms/mdx": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/mdx@594",
    "@studiocms/markdoc": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/markdoc@594",
    "@studiocms/cloudinary-image-service": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/cloudinary-image-service@594",

Summary by CodeRabbit

  • New Features

    • Added documentation and catalog entries for the new @studiocms/cloudinary-image-service and @studiocms/web-vitals plugins.
    • Introduced new configuration options and a detailed features reference in the documentation.
    • Added upgrade guide for version 0.1.0-beta.19, highlighting breaking changes and the new plugin system.
    • Extended plugin interface to support image service configuration.
  • Bug Fixes

    • Removed "NEW" badges from sidebar topics and guides for improved clarity.
  • Documentation

    • Major reorganization and updates to configuration references, including new and revised pages for features, locale, and SDK usage.
    • Updated plugin documentation with detailed options for the blog plugin.
    • Removed outdated documentation for deprecated configuration options.
    • Updated references from @astrojs/web-vitals to @studiocms/web-vitals.
    • Improved clarity and structure across multiple documentation pages.
    • Revised example usage to adopt new SDK invocation patterns and local context access.
  • Chores

    • Updated and locked dependency versions, including new plugin packages and updated Astro-related dependencies.
    • Expanded TypeDoc configuration to cover new plugins and additional source files.
    • Adjusted configuration files to support new plugins and enhanced error handling.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 18, 2025

Walkthrough

This update reorganizes and revises StudioCMS documentation and configuration. Several documentation files are removed, added, or rewritten, particularly around configuration, features, and plugins. New documentation and catalog entries are introduced for the Cloudinary image service and web-vitals plugins. Dependency versions and TypeDoc plugin configurations are updated, and references to SDK usage and CLI options are modernized.

Changes

Files / Areas Change Summary
src/content/docs/en/config-reference/*.mdx (dashboard, default-frontend-config, image-service, included-integrations, overrides, sdk) Removed documentation files for deprecated or restructured configuration options.
src/content/docs/en/config-reference/features.mdx, src/content/docs/en/config-reference/locale.mdx Added new documentation files detailing the features and locale configuration options.
src/content/docs/en/config-reference/index.mdx Updated main config reference: removed/added options, updated example config, and reorganized structure.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-18.mdx Removed "NEW" badge from sidebar metadata.
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-19.mdx Added upgrade guide for version 0.1.0-beta.19, detailing breaking changes and migration steps.
src/content/docs/en/how-it-works/cli.mdx Removed --color and --no-color CLI options from documentation.
src/content/docs/en/how-it-works/effect.mdx Added documentation explaining Effect library integration.
src/content/docs/en/how-it-works/index.mdx Updated sidebar badge, consolidated and expanded authentication virtual modules, removed SDK cache module.
src/content/docs/en/how-it-works/sdk.mdx Rewrote SDK usage documentation to focus on Effect-based usage and streamlined imports.
src/content/docs/en/package-catalog/community-plugins/web-vitals.mdx Updated all references from @astrojs/web-vitals to @studiocms/web-vitals.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-blog.mdx Improved structure, added explicit plugin routes and comprehensive options type documentation.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-cloudinary-js.mdx Added new documentation for the Cloudinary image service plugin, including installation and usage.
src/content/docs/en/plugins/extended.mdx Updated SDK usage examples to new Effect-based pattern, changed route/config access methods, removed badge.
src/content/docs/en/plugins/index.mdx Added setImageService method to the StudioCMSPlugin interface documentation.
src/content/docs/en/start-here/configuration.mdx Added "Updated" badge, clarified supported config file extensions, removed mention of auto-generated auth config file.
src/content/docs/en/start-here/environment-variables.mdx Added "Updated" badge, removed Cloudinary image handler environment variable section.
src/content/docs/en/start-here/getting-started.mdx Changed command type for DB push, updated authentication config reference link.
src/content/docs/en/utils/rendering.mdx Updated SDK usage in example, changed 404 handling, added "Updated" badge.
src/content/package-catalog/astrojs-web-vitals.json Updated GitHub repository URL for @astrojs/web-vitals.
src/content/package-catalog/studiocms-cloudinary-image-service.json, src/content/package-catalog/studiocms-web-vitals.json Added new package catalog entries for Cloudinary image service and web-vitals plugins.
astro.config.mts Updated sidebar: removed "NEW" badge from guides, added Cloudinary image service to typedoc references.
ec.config.mjs Added error code 2339 to TypeScript error handling in ecTwoSlash plugin config.
knip.config.ts Added Cloudinary image service to ignored dependencies.
package.json Updated dependency versions to URL-based, added/removed packages, updated Astro and plugin dependencies.
studiocms Updated subproject reference to a new commit.
typedoc.config.ts Added TypeDoc plugin for Cloudinary image service, expanded entry points for documentation generation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSite
    participant Plugin
    participant StudioCMS

    User->>DocsSite: Accesses documentation
    DocsSite->>DocsSite: Renders updated config, features, and plugin docs
    User->>DocsSite: Views Cloudinary image service setup
    DocsSite->>Plugin: Shows install/config instructions
    User->>StudioCMS: Applies new config patterns and plugin usage
Loading

Possibly related PRs

Poem

🐇✨
A hop, a skip, new docs appear,
Old config fades, new features clear.
Plugins cataloged, the Cloudinary shines,
SDK flows with Effect’s new lines.
From badges to badges, the docs are spry—
With every merge, the codebase grows high!
—Rabbit, with a twinkle in its eye


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9b14a8f and 69a7762.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • package.json (1 hunks)
  • src/content/package-catalog/studiocms-cloudinary-image-service.json (1 hunks)
  • studiocms (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • studiocms
  • src/content/package-catalog/studiocms-cloudinary-image-service.json
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Run Starlight Link Check

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.

@Adammatthiesen Adammatthiesen changed the title Update docs for Beta.19 update [WIP] Update docs for Beta.19 update Jul 18, 2025
@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Jul 18, 2025

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/config-reference/dashboard.mdx Source removed, will stop being tracked.
en/config-reference/default-frontend-config.mdx Source removed, will stop being tracked.
en/config-reference/features.mdx Localization added, will be marked as complete.
en/config-reference/image-service.mdx Source removed, will stop being tracked.
en/config-reference/included-integrations.mdx Source removed, will stop being tracked.
en/config-reference/index.mdx Source changed, localizations will be marked as outdated.
en/config-reference/locale.mdx Localization added, will be marked as complete.
en/config-reference/overrides.mdx Source removed, will stop being tracked.
en/config-reference/sdk.mdx Source removed, will stop being tracked.
en/guides/upgrade/version-guides/0-1-0-beta-18.mdx Source changed, localizations will be marked as outdated.
en/guides/upgrade/version-guides/0-1-0-beta-19.mdx Localization added, will be marked as complete.
en/how-it-works/cli.mdx Source changed, localizations will be marked as outdated.
en/how-it-works/effect.mdx Localization added, will be marked as complete.
en/how-it-works/index.mdx Source changed, localizations will be marked as outdated.
en/how-it-works/sdk.mdx Source changed, localizations will be marked as outdated.
en/package-catalog/community-plugins/web-vitals.mdx Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-blog.mdx Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-cloudinary-js.mdx Localization added, will be marked as complete.
en/plugins/extended.mdx Source changed, localizations will be marked as outdated.
en/plugins/index.mdx Source changed, localizations will be marked as outdated.
en/start-here/configuration.mdx Source changed, localizations will be marked as outdated.
en/start-here/environment-variables.mdx Source changed, localizations will be marked as outdated.
en/start-here/getting-started.mdx Source changed, localizations will be marked as outdated.
en/utils/rendering.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 changed the title [WIP] Update docs for Beta.19 update Update docs for Beta.19 update Jul 19, 2025
@Adammatthiesen Adammatthiesen marked this pull request as ready for review July 19, 2025 21:22
@Adammatthiesen Adammatthiesen requested a review from a team as a code owner July 19, 2025 21:22
@Adammatthiesen Adammatthiesen merged commit febb9a6 into main Jul 20, 2025
8 checks passed
@Adammatthiesen Adammatthiesen deleted the beta.19-update branch July 20, 2025 17:35
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 21, 2025
dreyfus92 pushed a commit that referenced this pull request Jul 21, 2025
* i18n(fr): update `0-1-0-beta-18` and translate `0-1-0-beta-19`

See #139

* apply some coderabbitai nitpicks
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 21, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 21, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 22, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 22, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 22, 2025
dreyfus92 added a commit that referenced this pull request Jul 22, 2025
See #139

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
dreyfus92 added a commit that referenced this pull request Jul 22, 2025
See #139

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
dreyfus92 added a commit that referenced this pull request Jul 22, 2025
See #139

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
dreyfus92 added a commit that referenced this pull request Jul 22, 2025
* i18n(fr): update `start-here`

See #139

* fix indentation because of copy/paste... en uses 3 spaces instead of 2

---------

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 24, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jul 24, 2025
dreyfus92 pushed a commit that referenced this pull request Jul 25, 2025
* i18n(fr): update `config-reference`

See #139

* update based on coderabbitai nitpicks
dreyfus92 added a commit that referenced this pull request Jul 25, 2025
See #139

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

4 participants