Skip to content

i18n(ko-KR): create config-reference/index.mdx#84

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

i18n(ko-KR): create config-reference/index.mdx#84
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:config-ref-index

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 18, 2025

Description

create config-reference/index.mdx

Summary by CodeRabbit

  • Documentation
    • Added a new Korean-language documentation page detailing StudioCMS configuration options, including descriptions, default values, usage examples, and links to advanced configuration references.

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

coderabbitai Bot commented Apr 18, 2025

Walkthrough

A new Korean-language documentation page has been added for StudioCMS configuration options. The page details the StudioCMSOptions schema, describing each configuration property, its type, default value, and usage with code examples. For more complex configuration objects, the page links to their respective detailed documentation. The structure includes internationalization metadata and utilizes a ReadMore component for expandable links.

Changes

File(s) Change Summary
src/content/docs/ko/config-reference/index.mdx Added a new Korean documentation page detailing StudioCMS configuration options, including descriptions, types, defaults, usage examples, and links to further references.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSite
    participant ReadMoreComponent

    User->>DocsSite: Accesses Korean config reference page
    DocsSite->>User: Renders config options, types, defaults, and code examples
    User->>ReadMoreComponent: Clicks "Read More" for detailed config
    ReadMoreComponent->>User: Expands with links to detailed documentation
Loading

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/config-reference/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

🔭 Outside diff range comments (1)
src/content/docs/ko/config-reference/index.mdx (1)

181-188: ⚠️ Potential issue

Fix MDX comment before link definitions
The {/* Links */} syntax is treated as JSX and may prevent the reference definitions from being parsed. Replace with a standard HTML comment:

- {/* Links */}
+ <!-- Links -->
 [overrides]: /ko/config-reference/overrides/
 [image-service]: /ko/config-reference/image-service/
 [default-frontend-config]: /ko/config-reference/default-frontend-config/
 [dashboard]: /ko/config-reference/dashboard/
 [included-integrations]: /ko/config-reference/included-integrations/
 [sdk]: /ko/config-reference/sdk/
🧹 Nitpick comments (2)
src/content/docs/ko/config-reference/index.mdx (2)

1-7: Optional: Add explicit locale metadata to frontmatter
It can be helpful to include the language code in your frontmatter for clarity and tooling support.

Consider adding:

---
 i18nReady: true
 title: StudioCMSOptions
 description: StudioCMSOptions 참조 페이지
 sidebar:
   order: 1
+lang: 'ko-KR'
---

11-11: Convert main title to a Markdown heading
Currently this line renders as plain text. To make it a top‑level heading in the generated page, prepend #:

- StudioCMS 통합 구성 옵션 스키마 참조
+ # StudioCMS 통합 구성 옵션 스키마 참조
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between de64eb4 and f1267d6.

📒 Files selected for processing (1)
  • src/content/docs/ko/config-reference/index.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (13)
src/content/docs/ko/config-reference/index.mdx (13)

9-10: Verify ReadMore import path
Ensure that the ~ alias resolves correctly in your Astro configuration. If the alias isn’t recognized, switch to a relative path such as:

- import ReadMore from '~/components/ReadMore.astro';
+ import ReadMore from '../../../components/ReadMore.astro';

34-49: Great: dbStartPage section follows the style guide
Header, description, and usage example are clear and consistent with other pages.


51-66: Great: dateLocale section is well‑structured
Type, default, and example usage are accurately documented.


68-83: Great: verbose section is clear
The explanation and code snippet correctly illustrate the flag’s behavior.


85-103: Great: plugins section matches patterns elsewhere
Array type, default, and sample integration import look good.


105-122: Great: componentRegistry section is consistent
Registry object usage is documented correctly with a concise example.


124-143: Great: dateTimeFormat section is comprehensive
Clear description of the options object and illustrative snippet.


145-150: Great: overrides link placeholder is clear
ReadMore component usage aligns with other sections.


151-156: Great: imageService link is correct
Consistent pattern for linking to more detailed docs.


157-162: Great: defaultFrontEndConfig link is consistent
Follows the same styling as other complex option sections.


163-168: Great: dashboardConfig link presentation is good
Consistent with the rest of the page.


169-174: Great: includedIntegrations section is accurate
ReadMore usage and link key are correct.


175-180: Great: sdk section is correctly documented
Follows the established pattern for linking to deeper docs.

Comment thread src/content/docs/ko/config-reference/index.mdx
@Adammatthiesen Adammatthiesen merged commit 2bdf1e5 into withstudiocms:main Apr 18, 2025
8 checks passed
@jsparkdev jsparkdev deleted the config-ref-index branch April 18, 2025 03:45
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