Skip to content

i18n(ko-KR): create translations.mdx#103

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

i18n(ko-KR): create translations.mdx#103
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:ff

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 20, 2025

Description

Summary by CodeRabbit

  • Documentation
    • Fixed a typo in a GitHub URL in the English translation guide.
    • Updated the Korean translation guide with expanded instructions, collaboration guidance, and detailed steps for contributing translations, including new sections on joining Discord, translation process, documentation structure, and translation status tracking. Placeholder text was replaced with updated contribution instructions.

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

coderabbitai Bot commented Apr 20, 2025

Walkthrough

This update corrects a typo in a GitHub URL within the English translation guide and makes substantial enhancements to the Korean translation guide. The Korean guide now includes expanded procedural instructions, collaboration guidance, documentation structure details, and updated collaboration channels. It also clarifies the translation process, introduces new sections for organization, and replaces outdated or placeholder content with current information.

Changes

File(s) Change Summary
src/content/docs/en/guides/contributing/translations.mdx Fixed a typo in a GitHub repository URL within a tip block, correcting "withstudicms" to "withstudiocms". No other changes made.
src/content/docs/ko/guides/contributing/translations.mdx Updated badge from "출시 예정" (Coming Soon) to "업데이트됨" (Updated). Added import for FileTree. Replaced "Dashboard Internationalization" with "Join Discord" section. Expanded and clarified translation process, added details on targeted languages, introduced subsections for getting started, documentation structure, and translation process. Included new collaboration guidance and removed outdated placeholder text, adding a caution about translating only ready pages.

Sequence Diagram(s)

sequenceDiagram
    participant Translator
    participant Discord
    participant GitHub
    participant Crowdin
    participant Docs Repo

    Translator->>Discord: Join translation channel for collaboration
    Translator->>GitHub: Review open PRs and issues
    Translator->>Crowdin: Contribute translations (if preferred)
    Crowdin-->>Docs Repo: Sync translations for next release
    Translator->>Docs Repo: Submit translation PRs/issues
    Docs Repo-->>Translator: Provide status tracker and feedback
Loading

Possibly related PRs

  • i18n(ko-KR): create translations.mdx #90: The main PR expands and updates the existing Korean translations documentation with detailed procedural content and collaboration guidance, while the retrieved PR initially created that Korean translations page and fixed a link in the English version; thus, the main PR builds directly upon the content introduced by the retrieved PR.

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
en/guides/contributing/translations.mdx Source changed, localizations will be marked as outdated.
ko/guides/contributing/translations.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/guides/contributing/translations.mdx (1)

7-10: Align badge variant with English guide
In the English version the “Updated” badge uses variant: success (green highlight), but here it’s set to variant: note. Consider switching to variant: success for visual consistency and prominence.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cc3c798 and 05dc11e.

📒 Files selected for processing (2)
  • src/content/docs/en/guides/contributing/translations.mdx (1 hunks)
  • src/content/docs/ko/guides/contributing/translations.mdx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (8)
src/content/docs/en/guides/contributing/translations.mdx (1)

23-25: Fixed typo in GitHub repository URL
Great catch updating the GitHub links from withstudicms to withstudiocms in the fallback tip. This ensures contributors land on the correct repos.

src/content/docs/ko/guides/contributing/translations.mdx (7)

12-14: Import FileTree for documentation structure
Good addition of import { FileTree } from '@astrojs/starlight/components'—this matches the English guide and enables the <FileTree> visualization.


17-18: Add “Discord에 참여” header
Introducing a dedicated Discord section helps translators find real‑time support. Well localized as “Discord에 참여.”


19-22: Localize Discord invitation
The link and explanatory text are accurately translated and maintain the same guiding tone as the English version.


23-25: Provide GitHub fallback for non‑Discord users
Including GitHub issue links as an alternative ensures everyone can participate. Links correctly point to withstudiocms.


37-38: Clarify automatic synchronization
Explicitly stating that contributions via Crowdin or GitHub auto‑sync for the next release improves clarity.


45-55: Expand “문서 번역” overview
Excellent expansion of target languages and community acknowledgment. The structure is clear and mirrors the English guide effectively.


64-93: Visualize repository layout with FileTree
Embedding the <FileTree> component provides a helpful visual aid. This aligns the Korean guide with the English structure section.

@Adammatthiesen Adammatthiesen merged commit 34e73ae into withstudiocms:main Apr 20, 2025
8 checks passed
@jsparkdev jsparkdev deleted the ff branch April 20, 2025 10:12
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 20, 2025
Adammatthiesen pushed a commit that referenced this pull request Apr 20, 2025
* i18n(fr): update `contributing/translations.mdx`

See #90

* i18n(fr): update `guides/contributing/translations`

See #73 and #103

* fix badge

* fix imports...

* fix formatting (Prettier probably...)

* typo
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