Skip to content

i18n(ko-KR): update cli.mdx#96

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

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

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 20, 2025

Description

Summary by CodeRabbit

  • Documentation
    • Significantly expanded and reorganized the StudioCMS CLI documentation.
    • Added detailed usage instructions, options, and examples for all CLI tools and commands.
    • Introduced documentation for the new @studiocms/upgrade CLI tool.
    • Improved clarity with a sidebar badge, enhanced table of contents, and clearer command descriptions.

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

coderabbitai Bot commented Apr 20, 2025

Walkthrough

The Korean documentation for StudioCMS CLI was thoroughly revised and expanded. The update reorganizes the structure, introduces a sidebar badge and table of contents, and clarifies the existence of multiple CLI tools (studiocms, create-studiocms, and @studiocms/upgrade). Each CLI tool now has detailed sections covering commands, options, arguments, and usage examples. The documentation includes enhanced explanations for commands such as crypto gen-jwt and init, and adds a new section for the upgrade tool. No changes were made to code or API signatures; all updates are documentation-only.

Changes

File(s) Change Summary
src/content/docs/ko/how-it-works/cli.mdx Extensively revised and expanded Korean CLI documentation: reorganized structure, added sidebar badge and TOC, clarified multiple CLI tools, and provided detailed command references, usage examples, and a new section for @studiocms/upgrade.

Possibly related PRs

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

7-12: Verify frontmatter badge and tableOfContents fields
Ensure that the new frontmatter keys badge and tableOfContents are supported by the Astro/Starlight MDX pipeline and correctly indented according to your frontmatter spec.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 61dbc5c and aa3178c.

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

[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...create-studiocms](#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 (11)
src/content/docs/ko/how-it-works/cli.mdx (11)

20-24: Check CLI listing translation and anchor links
The bulleted list clearly introduces each CLI tool, but please verify that the anchors #create-studiocms, #studiocms, and #studiocms-upgrade match the generated section IDs (backticks may affect slug generation).

🧰 Tools
🪛 LanguageTool

[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...create-studiocms](#create-studiocms)**: StudioCMS 프로젝트 스캐폴딩 CLI - **[`studiocms...

(UNLIKELY_OPENING_PUNCTUATION)


28-30: Approve studiocms section heading
The new heading and subheading succinctly introduce the studiocms CLI.


32-40: Approve CLI options code block
The usage and options for studiocms are clearly documented, matching the latest CLI output.


55-67: Verify usage examples for package managers
Please confirm that using npm run studiocms, pnpm studiocms, and yarn studiocms aligns with your recommended installation (vs. npx studiocms), and that these commands work out of the box as written.


75-85: Approve add command documentation
The add command snippet is accurate and the translation correctly preserves the structure of arguments and options.


90-93: Approve crypto commands documentation
The code block reflects the exact CLI output. Keeping the English text within the block is appropriate here.


117-125: Approve get-turso description and note
Translation and callout for WSL usage are clear and helpful.


137-145: Approve init command interactive options
The expanded interactive setup instructions are well translated and informative.


173-181: Approve create-studiocms section
Structure, headings, and command list align well with the rest of the CLI documentation.


198-209: Verify create-studiocms usage syntax
Confirm that npm create studiocms@latest (and the pnpm/yarn equivalents) is supported in your target npm versions, and that this syntax is preferred over npm init.


283-291: Approve upgrade CLI documentation
The new @studiocms-upgrade section is well structured, and examples for npm/pnpm/yarn correctly illustrate how to invoke the tool.

@Adammatthiesen Adammatthiesen merged commit ec5e028 into withstudiocms:main Apr 20, 2025
8 checks passed
@jsparkdev jsparkdev deleted the cli branch April 20, 2025 08:26
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