Skip to content

i18n(ko-KR): create plugins/index.mdx#87

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:plugin-index
Apr 18, 2025
Merged

i18n(ko-KR): create plugins/index.mdx#87
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:plugin-index

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 18, 2025

Description

  • create plugins/index.mdx
  • update frontmatter of extended.mdx

Summary by CodeRabbit

  • Documentation
    • Added a new Korean documentation page explaining the basics of StudioCMS plugins, including their structure, properties, and usage examples.
    • Updated the title of an existing Korean documentation page for improved clarity.

@jsparkdev jsparkdev requested a review from a team as a code owner April 18, 2025 12:15
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 18, 2025

Walkthrough

This update introduces a new Korean documentation file explaining the basics of StudioCMS plugins, including a comprehensive definition of the StudioCMSPlugin TypeScript type and its properties. The new file provides guidance for developers on creating and configuring plugins. Additionally, the title in the frontmatter of an existing Korean documentation file about plugins has been modified for clarity. No changes were made to any code or public API logic.

Changes

File(s) Change Summary
src/content/docs/ko/plugins/index.mdx Added new Korean documentation detailing StudioCMS plugins, their structure, and the StudioCMSPlugin type.
src/content/docs/ko/plugins/extended.mdx Changed the document title in the frontmatter 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/plugins/extended.mdx Localization changed, will be marked as complete.
ko/plugins/index.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 (4)
src/content/docs/ko/plugins/index.mdx (2)

1-7: Consistent YAML frontmatter indentation
The order field under sidebar is indented by three spaces. For consistency with typical YAML frontmatter in this repo, please use two spaces:

-sidebar:
-   order: 1
+sidebar:
+  order: 1

4-4: Refine description for clarity
To match the phrasing in other Korean docs (and the change in extended.mdx), consider adding “그”:

-description: StudioCMS 플러그인과 작동 방식에 대해 알아보세요.
+description: StudioCMS 플러그인과 그 작동 방식에 대해 알아보세요.
src/content/docs/ko/plugins/extended.mdx (2)

5-6: Standardize YAML frontmatter indentation
Similar to index.mdx, adjust the order indentation to two spaces:

-sidebar:
-   order: 2
+sidebar:
+  order: 2

4-4: Align description with extended content
Currently the description duplicates the introduction page; consider tailoring it to highlight that this guide covers building and extending useful plugins.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e351878 and b1f9bea.

📒 Files selected for processing (2)
  • src/content/docs/ko/plugins/extended.mdx (1 hunks)
  • src/content/docs/ko/plugins/index.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/ko/plugins/index.mdx

[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...져야 하며, 다음 속성들은 필수 사항입니다. - identifier: package.json 파일에 정의된 플러그인의 식별자입니다. - `n...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~260-~260: Loose punctuation mark.
Context: ...kage.json 파일에 정의된 플러그인의 식별자입니다. - name: StudioCMS 대시보드에 표시되는 플러그인의 레이블입니다. - `s...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~261-~261: Loose punctuation mark.
Context: ...러그인의 레이블입니다. - studiocmsMinimumVersion: 플러그인이 작동하는 데 필요한 StudioCMS의 최소 버전입니다. ...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (3)
src/content/docs/ko/plugins/index.mdx (1)

9-9: Verify import path alias resolution
Ensure that ~/components/ReadMore.astro is correctly resolved by your build setup (Vite/Astro alias). If not, please adjust the alias or use a relative path.

src/content/docs/ko/plugins/extended.mdx (2)

3-3: Approve frontmatter title refinement
The new title 유용한 플러그인 만들기 reads naturally in Korean and aligns with the intent.


10-10: Verify FileTree component import
Please confirm that @astrojs/starlight/components exports FileTree in your project setup. If the path or package name differs, update accordingly.

Comment thread src/content/docs/ko/plugins/index.mdx
@Adammatthiesen Adammatthiesen merged commit 30a473d into withstudiocms:main Apr 18, 2025
8 checks passed
@jsparkdev jsparkdev deleted the plugin-index branch April 18, 2025 13:49
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