Skip to content

i18n(ko-KR): create extended.mdx#85

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:plugins-extended
Apr 18, 2025
Merged

i18n(ko-KR): create extended.mdx#85
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:plugins-extended

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 18, 2025

Description

create extended.mdx

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Korean-language documentation explaining how to create and extend StudioCMS plugins, including step-by-step guides, code examples, and integration instructions for routes, dashboard items, and navigation menus.

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

coderabbitai Bot commented Apr 18, 2025

Walkthrough

A new Korean-language documentation file, extended.mdx, has been added. This document provides a detailed guide on creating and extending StudioCMS plugins. It covers plugin file structure, the process of defining a plugin using definePlugin, integration of routes and dashboard items, frontend navigation setup, and includes code examples and explanations. The documentation also introduces a new exported function, studioCMSPageInjector, which demonstrates how to implement a StudioCMS plugin with various features and integration points.

Changes

File(s) Change Summary
src/content/docs/ko/plugins/extended.mdx Added comprehensive Korean documentation for creating and extending StudioCMS plugins, with code samples.
src/index.ts (referenced in documentation) Introduced exported function studioCMSPageInjector as part of the plugin definition example.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant StudioCMS
    participant Plugin (studioCMSPageInjector)
    participant Frontend (Navigation.astro)
    participant SDK

    Developer->>Plugin: Define plugin with definePlugin
    Plugin->>StudioCMS: Register integration, routes, dashboard items, navigation links
    Frontend->>StudioCMS: Request navigation links
    StudioCMS->>Plugin: Provide navigation links
    Frontend->>Plugin: Render navigation menu with links
    Frontend->>Plugin: Access dynamic route ([...slug].astro)
    Plugin->>SDK: Fetch pages/site config
    SDK-->>Plugin: Return data
    Plugin->>Frontend: Render page content or list
Loading

Possibly related PRs

  • i18n(fr): add plugins pages #36: Adds French documentation and code examples for creating and extending StudioCMS plugins, closely matching the new Korean documentation and plugin example.

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

🧹 Nitpick comments (3)
src/content/docs/ko/plugins/extended.mdx (3)

1-7: Frontmatter consistency and translation accuracy
The title value 플러그인을 유용하게 만들기 ("Making plugins useful") may not precisely reflect the original intent of "Create and Extend StudioCMS Plugins." Consider a more idiomatic translation such as 플러그인 확장하기 또는 플러그인 생성 및 확장. Also verify that i18nReady and sidebar.order conform to existing locale files.


20-30: FileTree block formatting
현재 <FileTree> 안의 리스트 항목이 제대로 동작하겠지만, 중첩된 항목을 두 칸씩 들여쓰기해 가독성을 높일 수 있습니다.

예:

 <FileTree>
- - package.json
- - src
-   - index.ts
+  - package.json
+  - src
+    - index.ts
     - routes
       - [...slug].astro
     - dashboard-grid-items
       - MyPluginGridItem.astro
 </FileTree>

227-312: Missing closing code fence and indent consistency in Navigation snippet

  1. The snippet opened at line 227 (astro title="Navigation.astro") has no closing ```````.
  2. Mixed tabs and spaces are used for indentation inside the snippet. Standardize to two spaces per level for consistency.

Example diff for the closing fence:

 312~) }
+313~```  

And replace tabs with two spaces in lines 235, 239, etc.


</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

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

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 2bdf1e5d52bf49d1f514243167101e6226e4260d and 462212e1fa554efafa28abc5fb14859cf9c6b2af.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `src/content/docs/ko/plugins/extended.mdx` (1 hunks)

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms (1)</summary>

* GitHub Check: Run Starlight Link Check

</details>

<details>
<summary>🔇 Additional comments (3)</summary><blockquote>

<details>
<summary>src/content/docs/ko/plugins/extended.mdx (3)</summary>

`9-11`: **Verify import paths**  
The MDX imports use the `~` alias (`~/components/ReadMore.astro`) and a bare npm package (`@astrojs/starlight/components`). Please confirm that your MDX/Astro configuration supports the `~` alias and that `@astrojs/starlight` is installed; otherwise switch to relative imports (e.g., `../../components/ReadMore.astro`).

---

`12-15`: **Introduction clarity**  
설명 문단이 간결하고 플러그인의 목적 및 기능 확장 방식을 잘 전달하고 있습니다.

---

`121-124`: **ReadMore 컴포넌트 사용 확인**  
`<ReadMore>` 컴포넌트가 적절히 사용되었고, 링크 대상도 정확합니다.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Comment thread src/content/docs/ko/plugins/extended.mdx
Comment thread src/content/docs/ko/plugins/extended.mdx
Comment thread src/content/docs/ko/plugins/extended.mdx
Comment thread src/content/docs/ko/plugins/extended.mdx
@Adammatthiesen Adammatthiesen merged commit 2599a2d into withstudiocms:main Apr 18, 2025
8 checks passed
@jsparkdev jsparkdev deleted the plugins-extended branch April 18, 2025 03:50
@coderabbitai coderabbitai Bot mentioned this pull request May 10, 2025
3 tasks
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