Skip to content

i18n(ko-KR): create package-catalog/#67

Merged
Adammatthiesen merged 6 commits into
withstudiocms:mainfrom
jsparkdev:plugin-blog
Apr 16, 2025
Merged

i18n(ko-KR): create package-catalog/#67
Adammatthiesen merged 6 commits into
withstudiocms:mainfrom
jsparkdev:plugin-blog

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 16, 2025

Description

create package-catalog/

Summary by CodeRabbit

  • Documentation
    • Added new Korean-language documentation pages for the package catalog and multiple StudioCMS and community plugin integrations, including installation and usage instructions for @astrojs/web-vitals, @studiocms/blog, @studiocms/devapps, @studiocms/markdoc, and @studiocms/mdx.
    • Enhanced documentation with bilingual introductions, step-by-step guides, configuration examples, and UI component usage for improved clarity and accessibility.

@jsparkdev jsparkdev requested a review from a team as a code owner April 16, 2025 08:02
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 16, 2025

Walkthrough

This update introduces new Korean-language documentation files for the StudioCMS package catalog and several plugin integrations, including @astrojs/web-vitals, @studiocms/blog, @studiocms/devapps, @studiocms/markdoc, and @studiocms/mdx. The documentation provides introductions, installation guides, configuration examples, and feature descriptions for each plugin. The main package catalog page explains badge labels and organizes packages into StudioCMS and community sections. The new files utilize UI components for better organization and clarity, and some include commented-out demo or preview sections.

Changes

Files/Paths Change Summary
src/content/docs/ko/package-catalog/index.mdx Adds a Korean package catalog documentation page, describing package types, badge labels, and rendering package lists via components.
src/content/docs/ko/package-catalog/community-plugins/web-vitals.mdx Adds documentation for the @astrojs/web-vitals integration, including intro, installation, and configuration instructions.
src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-blog.mdx Adds documentation for the @studiocms/blog plugin, covering intro, installation, configuration, and new routes/features.
src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-devapps.mdx Adds documentation for @studiocms/devapps, including intro, install steps, usage, config options, and tool descriptions.
src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-markdoc.mdx, .../studiocms-mdx.mdx Adds documentation for @studiocms/markdoc and @studiocms/mdx plugins, with intros, install/config guides, and metadata.

Possibly related PRs

Suggested labels

i18n

Suggested reviewers

  • Adammatthiesen

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

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

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
ko/package-catalog/community-plugins/web-vitals.mdx Localization added, will be marked as complete.
ko/package-catalog/index.mdx Localization added, will be marked as complete.
ko/package-catalog/studiocms-plugins/studiocms-blog.mdx Localization added, will be marked as complete.
ko/package-catalog/studiocms-plugins/studiocms-devapps.mdx Localization added, will be marked as complete.
ko/package-catalog/studiocms-plugins/studiocms-markdoc.mdx Localization added, will be marked as complete.
ko/package-catalog/studiocms-plugins/studiocms-mdx.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.

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 (1)
src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1)

1-131: Consider adding links to related documentation for enhanced navigation.

While the documentation is comprehensive, consider adding links to related docs (e.g., @astrojs/db, @studiocms/blog, or Astro integration guides) where referenced. This will help users quickly find more information about prerequisites or related packages.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5e825a0 and db42bfc.

📒 Files selected for processing (6)
  • src/content/docs/ko/package-catalog/community-plugins/web-vitals.mdx (1 hunks)
  • src/content/docs/ko/package-catalog/index.mdx (1 hunks)
  • src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-blog.mdx (1 hunks)
  • src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1 hunks)
  • src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1 hunks)
  • src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1 hunks)
🔇 Additional comments (12)
src/content/docs/ko/package-catalog/index.mdx (1)

1-27: Well-structured and clear documentation for the package catalog.

The page provides a clear introduction, badge explanations, and organizes the catalog into StudioCMS and community sections. Component usage and Korean localization are correct.

src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-blog.mdx (1)

1-48: Comprehensive and accurate plugin documentation.

The installation, configuration, and usage instructions are clear and well-structured. The documentation uses Korean appropriately and describes the plugin's features and routes effectively.

src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1)

1-38: Clear and accurate documentation for MarkDoc integration.

The installation and configuration instructions are correct, and the documentation is concise and well-localized in Korean.

src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1)

1-38: Accurate and well-structured documentation for MDX integration.

The instructions are clear, and the documentation is consistent with the other plugin docs and well-localized in Korean.

src/content/docs/ko/package-catalog/community-plugins/web-vitals.mdx (1)

1-79: Thorough and clear documentation for web-vitals integration.

The installation and configuration instructions are accurate, and the documentation is well-organized and localized in Korean. The commented-out gallery section is non-blocking.

src/content/docs/ko/package-catalog/studiocms-plugins/studiocms-devapps.mdx (7)

13-14: Component imports are clear and appropriate.

The imports for PackageManagers, Steps, Tabs, and TabItem are correct and follow Starlight/Astro conventions. No issues found.


22-55: Excellent use of tabs and package manager components for installation instructions.

The installation section is well-structured, providing both Astro and direct install methods with clear, localized instructions and code snippets. The use of <PackageManagers /> and <Tabs /> enhances clarity for users.


40-52: Configuration code snippet is clear and accurate.

The example astro.config.mjs snippet is correct and follows Astro integration conventions. The use of ins={3, 9} and code comments is helpful for users.


63-75: Configuration example is clear and matches Astro best practices.

The configuration example for enabling both db() and devApps() integrations is accurate and includes helpful comments for users.


81-93: Comprehensive configuration options with defaults.

The documentation lists all available options for devApps with defaults, making it easy for users to understand customization. The code block is clear and well-commented.


97-116: libSQL Viewer section is clear and informative.

The section explains prerequisites, usage, and provides preview images. The environment variable requirements are clearly listed and match typical usage for @astrojs/db.


117-131: WordPress Importer section is clear and complete.

The section lists all prerequisites, including the optional @studiocms/blog integration, and provides a preview image. The instructions are concise and localized.

@Adammatthiesen Adammatthiesen merged commit ca65ad7 into withstudiocms:main Apr 16, 2025
7 checks passed
@jsparkdev jsparkdev deleted the plugin-blog branch April 16, 2025 08:56
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.

3 participants