Skip to content

i18n(ko-KR): create contributing/getting-started.mdx#78

Merged
Adammatthiesen merged 4 commits into
withstudiocms:mainfrom
jsparkdev:con-start
Apr 17, 2025
Merged

i18n(ko-KR): create contributing/getting-started.mdx#78
Adammatthiesen merged 4 commits into
withstudiocms:mainfrom
jsparkdev:con-start

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 17, 2025

Description

create contributing/getting-started.mdx

Summary by CodeRabbit

  • Documentation
    • Added a Korean "Getting Started" guide for contributors, including community guidelines, contribution instructions, and a dynamic contributor list.

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

coderabbitai Bot commented Apr 17, 2025

Walkthrough

A new Korean-language documentation file, getting-started.mdx, has been added under the contributing section. This file provides a "Getting Started" guide for contributors to the StudioCMS project, including project information, contribution guidelines, a code of conduct reference, instructions for submitting issues, and a dynamically rendered contributor list using a JSX component. The file is structured with metadata and headings for clarity and navigation.

Changes

File(s) Change Summary
src/content/docs/ko/contributing/getting-started.mdx Added a new Korean "Getting Started" guide for contributors, including metadata, contribution instructions, code of conduct reference, and dynamic contributor list.

Possibly related PRs

  • i18n(fr): add contributing pages #38: Adds a French "getting-started" contributing guide with similar structure and content, indicating it is a translated counterpart to the Korean guide added in this PR.

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.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2fbcff3 and 5158eb0.

📒 Files selected for processing (1)
  • src/content/docs/ko/contributing/getting-started.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/ko/contributing/getting-started.mdx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check

🪧 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

studiocms-no-reply commented Apr 17, 2025

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/contributing/getting-started.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: 2

🧹 Nitpick comments (2)
src/content/docs/ko/contributing/getting-started.mdx (2)

16-21: Optional: Clarify the dynamic contributor list
The ## 기여자 section is well structured. For first-time readers, you might add a brief sentence explaining that avatars are pulled in dynamically. This small note can set expectations before <ContributorList />.

Example addition:

## 기여자

이 프로젝트는 기여해주신 모든 분들 덕분에 존재합니다. [GitHub에 참여하세요](https://github.com/withstudiocms/studiocms).

이 아래에 있는 프로필 사진은 자동으로 업데이트됩니다:
<ContributorList />

22-28: Clean up MDX comment style & add trailing newline
The JSX comment {/* Links */} is optional and may be replaced with a standard Markdown comment. Also, ensure the file ends with a newline for POSIX compliance.

--- a/src/content/docs/ko/contributing/getting-started.mdx
+++ b/src/content/docs/ko/contributing/getting-started.mdx
@@
-{/* Links */}
+[<!-- Links -->]
@@
-[how-it-works]: /ko/how-it-works/
+[how-it-works]: /ko/how-it-works/

+  ← (ensure a final newline here)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a41ad1c and 2fbcff3.

📒 Files selected for processing (1)
  • src/content/docs/ko/contributing/getting-started.mdx (1 hunks)
🔇 Additional comments (2)
src/content/docs/ko/contributing/getting-started.mdx (2)

8-8: Verify the import alias for ContributorList
You’re using from '~/components/ContributorList.astro'. Ensure the ~ alias is configured correctly in your Astro (or bundler) settings. If your project uses a different alias (e.g., @components), please update this import to prevent build failures.


14-15: Confirm the [how-it-works] alias resolves correctly
You reference [작동 방식][how-it-works]. Please verify that the alias defined at the bottom (/ko/how-it-works/) points to the correct Korean “How It Works” page and that navigation works as expected in your sidebar.

Comment thread src/content/docs/ko/contributing/getting-started.mdx
Comment thread src/content/docs/ko/contributing/getting-started.mdx
Adammatthiesen and others added 3 commits April 16, 2025 23:20
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@jsparkdev
Copy link
Copy Markdown
Contributor Author

@Adammatthiesen

I've fixed it.

@Adammatthiesen Adammatthiesen merged commit 89daa8e into withstudiocms:main Apr 17, 2025
8 checks passed
@jsparkdev jsparkdev deleted the con-start branch April 17, 2025 08:08
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