Skip to content

i18n(ko-KR): update overrides.mdx#44

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:over
Apr 11, 2025
Merged

i18n(ko-KR): update overrides.mdx#44
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:over

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 11, 2025

Description

update overrides.mdx into Korean

Summary by CodeRabbit

  • Documentation
    • Introduced new documentation for configuring integration options.
    • Detailed two new configuration overrides for custom image and date components with usage examples and default values.

@jsparkdev jsparkdev requested a review from a team as a code owner April 11, 2025 03:48
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 11, 2025

Walkthrough

A new documentation file has been added at src/content/docs/ko/config-reference/overrides.mdx. This file introduces reference documentation for the StudioCMSOptions overrides, specifically detailing the CustomImageOverride and FormattedDateOverride options. It includes metadata (such as i18nReady, title, description, and sidebar order), descriptions, default values, and TypeScript usage examples, along with a basic component example for formatting dates.

Changes

File(s) Change Summary
src/content/docs/ko/config-reference/overrides.mdx Added a documentation file for StudioCMSOptions overrides, detailing CustomImageOverride and FormattedDateOverride with examples.

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 plan to trigger planning for file edits and PR creation.
  • @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/config-reference/overrides.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: 1

🧹 Nitpick comments (1)
src/content/docs/ko/config-reference/overrides.mdx (1)

9-9: Optional: Remove Unused Import

The ReadMore component is imported at line 9 but isn’t used anywhere in this file. Consider removing this import if it’s not intended for future use to reduce potential confusion.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5e288ac and fcb5ddd.

📒 Files selected for processing (1)
  • src/content/docs/ko/config-reference/overrides.mdx (1 hunks)
🔇 Additional comments (5)
src/content/docs/ko/config-reference/overrides.mdx (5)

1-7: Front Matter Metadata is Well-Defined

The YAML front matter is well-structured with the necessary keys (including i18nReady, title, description, and sidebar order) to correctly configure the documentation page.


11-11: Clear Introduction Text

The introduction text ("StudioCMS 통합 구성 옵션 스키마 참조") immediately sets the context for the document and informs the reader about the configuration reference.


13-22: Comprehensive Configuration Example

The TypeScript configuration snippet clearly demonstrates how to define StudioCMS configuration with the specified overrides. The inclusion of the ---cut--- comment effectively hides nonessential details, keeping the focus on the relevant parts. Ensure that the override paths provided (e.g., src/components/CustomImage.astro) accurately reflect the project’s structure.


24-41: Detailed CustomImageOverride Documentation

The section for CustomImageOverride is well-documented: it explains the purpose, lists the type (string), and specifies the default value (undefined). The usage example further clarifies how to integrate the override into the configuration.


43-60: Well-Structured FormattedDateOverride Documentation

This section mirrors the clarity and structure of the CustomImageOverride section. It provides a clear description, type information (string), and the default value (undefined), along with a succinct usage example.

Comment thread src/content/docs/ko/config-reference/overrides.mdx
@Adammatthiesen Adammatthiesen merged commit 2c71813 into withstudiocms:main Apr 11, 2025
6 of 7 checks passed
@jsparkdev jsparkdev deleted the over branch April 11, 2025 08:24
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