Skip to content

i18n(ko-KR): create cli.mdx#91

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:cli
Apr 18, 2025
Merged

i18n(ko-KR): create cli.mdx#91
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:cli

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 18, 2025

Description

create cli.mdx

Summary by CodeRabbit

  • Documentation
    • Added a new Korean-language documentation page detailing the usage of StudioCMS CLI tools, including installation steps, available commands, environment variable setup, and links to related resources.

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

coderabbitai Bot commented Apr 18, 2025

Walkthrough

A new Korean-language documentation page for StudioCMS has been introduced, focusing on the command-line interface (CLI) tools available within the ecosystem. The page describes two primary CLI tools: create-studiocms for initializing projects and studiocms for utility and setup commands. It provides installation instructions, command usage patterns, descriptions of available options, and highlights platform-specific notes. The document also lists required environment variables and references additional resources and templates.

Changes

File(s) Change Summary
src/content/docs/ko/how-it-works/cli.mdx Added a new Korean documentation page detailing the usage, commands, options, and setup instructions for StudioCMS CLIs.

Suggested labels

i18n

Suggested reviewers

  • Adammatthiesen

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/how-it-works/cli.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 (5)
src/content/docs/ko/how-it-works/cli.mdx (5)

1-7: Frontmatter formatting consistency
The YAML frontmatter is valid, but consider using a consistent 2-space indentation under sidebar: instead of 3 spaces for better readability and maintainability.


12-13: Align heading with page title
The first-level heading is currently # 소개. To reinforce the subject of this page, you might change it to # CLI 소개 or # StudioCMS CLI, matching the title: "CLI" in the frontmatter.


16-19: Consistent punctuation in bullet list
Lines 16–19 mix colons with no terminal punctuation. For a cleaner look and to address the loose‐punctuation warning, either add a period at the end of each item or remove the colon.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~18-~18: Loose punctuation mark.
Context: ... 다른 CLI가 있습니다. - create-studiocms: StudioCMS 프로젝트 스캐폴딩 CLI - **studiocms...

(UNLIKELY_OPENING_PUNCTUATION)


27-43: Unify JSX attribute quoting
The <Tabs> component uses single quotes for its prop (syncKey='pkgs'), while <TabItem> uses double quotes. For consistency with standard MDX/JSX style, use double quotes on all component attributes:

-<Tabs syncKey='pkgs'>
+<Tabs syncKey="pkgs">

112-113: Avoid Markdown links inside help output blocks
This line is inside a log code block:

Start the interactive CLI. Powered by [clack](https://clack.cc).

If it represents literal CLI output, remove the Markdown link. If it's explanatory, move it outside the code block so that the help snippet remains authentic.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bca23c3 and 677fbba.

📒 Files selected for processing (1)
  • src/content/docs/ko/how-it-works/cli.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/ko/how-it-works/cli.mdx

[uncategorized] ~18-~18: Loose punctuation mark.
Context: ... 다른 CLI가 있습니다. - create-studiocms: StudioCMS 프로젝트 스캐폴딩 CLI - **studiocms...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (4)
src/content/docs/ko/how-it-works/cli.mdx (4)

9-11: Verify import path aliases
Ensure the ~ alias used in

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

is configured correctly in your Astro project (tsconfig.json / astro.config.mjs) to resolve to the intended directory.


33-38: Consistent icon identifiers
The pnpm tab specifies icon="pnpm", whereas npm and yarn use the seti: prefix (e.g., seti:npm). Verify that "pnpm" is a valid icon key in your icon set, or switch to a matching prefix like seti:pnpm for a uniform appearance.


210-216: Verify documentation links
Please confirm that the reference links

[templates]: https://github.com/withstudiocms/templates  
[environment-variables]: /ko/start-here/environment-variables/

resolve correctly in your Korean site routing. Broken or misrouted links can confuse readers.


14-16: Clear and concise introduction
The description of StudioCMS CLI in Korean is well‑written and immediately communicates the purpose of the tools. Nice work!

@Adammatthiesen Adammatthiesen merged commit a85d322 into withstudiocms:main Apr 18, 2025
8 checks passed
@jsparkdev jsparkdev deleted the cli branch April 18, 2025 14:53
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