Skip to content

StudioCMS Beta.16 release docs#73

Merged
Adammatthiesen merged 75 commits into
mainfrom
studiocms-beta.16
Apr 20, 2025
Merged

StudioCMS Beta.16 release docs#73
Adammatthiesen merged 75 commits into
mainfrom
studiocms-beta.16

Conversation

@Adammatthiesen
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen commented Apr 16, 2025

Updates docs to reflect changes in StudioCMS Beta.16

DO NOT MERGE BEFORE: withstudiocms/studiocms#559

This PR will require small tweaks before it will be ready to merge to move it off the pre mode used for testing.

  • Update package.json with beta.16 versions for StudioCMS packages
  • Update scripts/generate-release-notes.ts line 12 to false

Bonus:

Summary by CodeRabbit

  • New Features

    • Added "Quick Update" component and localization for streamlined package updates.
    • Introduced experimental badge and flag for plugins in the package catalog.
    • Added support for internal package catalog entries.
    • New sponsor link for Skip2 Networks.
    • Sidebar translations now support additional languages.
  • Documentation

    • Added and updated guides for contributing, translations, upgrade instructions, and database setup (including self-hosted libSQL server).
    • Introduced new documentation for the @studiocms/wysiwyg plugin.
    • Enhanced CLI documentation with detailed usage and new commands.
    • Improved installation instructions and clarified configuration steps for plugins.
    • Updated and reorganized sidebar and guide navigation.
    • Fixed and updated contributor links across multiple languages.
  • Bug Fixes

    • Corrected contributor section links in various language guides.
  • Chores

    • Upgraded multiple dependencies to latest versions.
    • Automated changelog generation during build and development processes.
    • Updated configuration paths and file patterns for consistency.
  • Refactor

    • Reorganized sidebar structure and translation handling.
    • Adjusted package catalog and integration schemas to support new features.
  • Style

    • Removed custom styles for heading anchor links.
  • Tests

    • Expanded spell checker dictionary for development.
  • Revert

    • Removed deprecated sidebar translation file.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 16, 2025

Walkthrough

This set of changes introduces new and updated documentation, configuration, and code to enhance StudioCMS, with a focus on internationalization, upgrade guidance, and package catalog improvements. Notable additions include a comprehensive translations guide in English and Korean, a self-hosted libSQL server setup guide, and automated generation of release notes from changelogs. The package catalog is expanded with new metadata and badges, including "Experimental" status, and a new WYSIWYG plugin entry. Infrastructure changes update configuration paths, sidebar organization, and scripts for changelog generation. Several dependencies are upgraded, and minor UI, CSS, and sponsor updates are included.

Changes

File(s) / Path(s) Change Summary
.gitignore Added changelog markdown file to ignore list.
.vscode/settings.json Added custom spell-check words.
astro.config.mts, lunaria.config.ts, knip.config.ts, hostUtils.ts Updated import paths, plugin config, dependency ignore list, and env var name.
package.json Added changelog generation script, updated scripts to run it, upgraded dependencies, added new packages.
scripts/generate-release-notes.ts, scripts/lib/changelogs.ts, scripts/lib/utils.ts Added scripts for fetching, parsing, and writing release notes from changelogs.
src/components/Integration.astro, src/components/PackageCatalog.astro Added and passed experimental prop for integrations.
src/components/QuickUpdate.astro New component for quick update command snippet.
src/components/Sponsors.astro, src/share-link.ts Added Skip2 Networks sponsor link and data.
src/content.config.ts Extended schemas: new catalog type, experimental and replaceTitle flags, new i18n string.
src/content/docs/en/guides/database/sqld-server.mdx New guide for self-hosted libSQL server with Docker.
src/content/docs/en/guides/index.mdx, src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-16.mdx Added new guides index and upgrade guide for v0.1.0-beta.16.
src/content/docs/en/guides/contributing/translations.mdx, src/content/docs/ko/guides/contributing/translations.mdx Added comprehensive translation guides in English and Korean.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx, src/content/package-catalog/studiocms-wysiwyg.json, src/content/package-catalog/studiocms.json Added documentation and metadata for new WYSIWYG plugin and main package.
src/content/docs/en/how-it-works/cli.mdx Major expansion and restructuring of CLI documentation.
src/content/docs/en/package-catalog/index.mdx Added "Experimental" badge explanation.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-blog.mdx, src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx, src/content/docs/en/package-catalog/studiocms-plugins/studiocms-mdx.mdx Updated installation instructions for plugins.
src/content/docs/en/index.mdx Changed demo card title and video to local MP4.
src/content/docs/en/start-here/getting-started.mdx Added upgrade guide link, updated URLs, and internal references.
src/content/docs/en/guides/contributing/code-contributions.mdx, src/content/docs/en/guides/contributing/getting-started.mdx, src/content/docs/de/guides/contributing/code-contributions.mdx, src/content/docs/es/guides/contributing/code-contributions.mdx, src/content/docs/fr/guides/contributing/code-contributions.mdx, src/content/docs/ko/guides/contributing/code-contributions.mdx Updated contributor link paths and/or descriptions in multiple languages.
src/content/i18n/en.json Added new i18n string for "quick-update".
src/pages/[lang]/guides/upgrade/latest.astro New dynamic redirect page to the latest upgrade guide per language.
src/starlight-sidebar/availTranslations.ts, src/starlight-sidebar/en.json, src/starlight-sidebar/translate.ts Added supported languages tuple, new sidebar translations, and translation function module.
src/starlightOverrides/PageTitle.astro Conditional title rendering based on replaceTitle flag.
src/plugins/rehypePluginKit.ts, src/styles/starlight.css Disabled autolink headings plugin; removed related CSS.
starlight-sidebar/translate.ts Deleted old sidebar translation module.
studiocms Updated submodule reference to new commit.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSite
    participant Scripts
    participant GitHub

    User->>DocsSite: Navigates to /[lang]/guides/upgrade/latest/
    DocsSite->>DocsSite: Load all version guide files for language
    DocsSite->>DocsSite: Convert version strings to semver
    DocsSite->>DocsSite: Determine latest version
    DocsSite->>User: Redirect to latest upgrade guide

    Scripts->>GitHub: Fetch changelog markdown
    GitHub-->>Scripts: Return changelog content
    Scripts->>Scripts: Parse changelog into AST
    Scripts->>Scripts: Generate markdown release notes
    Scripts->>Filesystem: Write release notes to file
Loading

Assessment against linked issues

Objective Addressed Explanation
Provide a step-by-step guide for hosting a self-hosted libSQL instance with Docker for StudioCMS (#51)
Include prerequisites, key generation, JWT setup, Docker Compose config, and integration with StudioCMS (#51)
Use clear, accurate commands and configuration snippets as described in the issue (#51)
Document that the guide targets development environment, not production (#51)

Possibly related PRs


📜 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 f1bd37a and 17da620.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • package.json (3 hunks)
  • scripts/generate-release-notes.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • scripts/generate-release-notes.ts
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms (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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

studiocms-no-reply commented Apr 16, 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
de/guides/contributing/code-contributions.mdx Localization added, will be marked as complete.
de/guides/contributing/getting-started.mdx Localization added, will be marked as complete.
de/guides/contributing/translations.mdx Localization added, will be marked as complete.
en/contributing/translations.mdx Source removed, will stop being tracked.
en/guides/contributing/code-contributions.mdx Localization added, will be marked as complete.
en/guides/contributing/getting-started.mdx Localization added, will be marked as complete.
en/guides/contributing/translations.mdx Localization added, will be marked as complete.
en/guides/database/sqld-server.mdx Localization added, will be marked as complete.
en/guides/index.mdx Localization added, will be marked as complete.
en/guides/upgrade/version-guides/0-1-0-beta-16.mdx Localization added, will be marked as complete.
en/how-it-works/cli.mdx Source changed, localizations will be marked as outdated.
en/index.mdx Source changed, localizations will be marked as outdated.
en/package-catalog/index.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-markdoc.mdx Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-mdx.mdx Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx Localization added, will be marked as complete.
en/start-here/getting-started.mdx Source changed, localizations will be marked as outdated.
es/guides/contributing/code-contributions.mdx Localization added, will be marked as complete.
es/guides/contributing/getting-started.mdx Localization added, will be marked as complete.
es/guides/contributing/translations.mdx Localization added, will be marked as complete.
fr/guides/contributing/code-contributions.mdx Localization added, will be marked as complete.
fr/guides/contributing/getting-started.mdx Localization added, will be marked as complete.
fr/guides/contributing/translations.mdx Localization added, will be marked as complete.
ko/guides/contributing/code-contributions.mdx Localization added, will be marked as complete.
ko/guides/contributing/getting-started.mdx Localization added, will be marked as complete.
ko/guides/contributing/translations.mdx Localization added, will be marked as complete.
src/content/i18n/en.json 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.

ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 20, 2025
Adammatthiesen pushed a commit that referenced this pull request Apr 20, 2025
* i18n(fr): update `contributing/translations.mdx`

See #90

* i18n(fr): update `guides/contributing/translations`

See #73 and #103

* fix badge

* fix imports...

* fix formatting (Prettier probably...)

* typo
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
dreyfus92 pushed a commit that referenced this pull request Apr 21, 2025
dreyfus92 added a commit that referenced this pull request Apr 21, 2025
See #73

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
dreyfus92 pushed a commit that referenced this pull request Apr 21, 2025
* i18n(fr): update `package-catalog`

See #73

* update code blocks highlighting

See #106
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
dreyfus92 pushed a commit that referenced this pull request Apr 21, 2025
* i18n(fr): update `how-it-works/cli`

See #73 and #104

* fix link in `start-here/getting-started`
dreyfus92 pushed a commit that referenced this pull request Apr 21, 2025
* i18n(fr): translate new `guides` pages

See #73

* fix link
dreyfus92 added a commit that referenced this pull request Apr 21, 2025
…124)

See #73 and #106

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
@coderabbitai coderabbitai Bot mentioned this pull request Oct 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to host your own libSQL instance on Docker guide

7 participants