Skip to content

i18n(ko-KR): create getting-started.mdx#76

Merged
Adammatthiesen merged 4 commits into
withstudiocms:mainfrom
jsparkdev:getting-started
Apr 17, 2025
Merged

i18n(ko-KR): create getting-started.mdx#76
Adammatthiesen merged 4 commits into
withstudiocms:mainfrom
jsparkdev:getting-started

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 17, 2025

Description

create getting-started.mdx

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Korean-language "Getting Started" guide for StudioCMS with detailed setup, database configuration, installation options, authentication setup, and frontend integration instructions.
    • Updated a Korean documentation link to ensure accurate navigation to the OAuth configuration section.

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

coderabbitai Bot commented Apr 17, 2025

Walkthrough

A new Korean-language documentation page, "시작하기" (Getting Started), has been added for StudioCMS. This page provides detailed, step-by-step instructions for setting up StudioCMS with Astro, including prerequisites, database setup, multiple installation methods, authentication configuration, and frontend integration. The documentation includes command examples, environment variable guidance, and references to related resources. It is organized with UI components such as tabs, steps, and asides to enhance readability and user experience. Additionally, a minor update was made to the Korean environment variables page to correct an anchor link to match the localized heading.

Changes

File(s) Change Summary
src/content/docs/ko/start-here/getting-started.mdx Added a comprehensive Korean "Getting Started" documentation page for StudioCMS, including setup, installation, and usage instructions with embedded components and links to related resources.
src/content/docs/ko/start-here/environment-variables.mdx Updated a Markdown anchor link to point to the correct Korean localized heading for OAuth configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    User ->> Docs: Access "시작하기" (Getting Started) page
    Docs ->> User: Display prerequisites and setup instructions
    User ->> Docs: Follow database setup and configuration steps
    Docs ->> User: Provide installation and authentication guidance
    User ->> Docs: Complete frontend integration and deployment steps
    Docs ->> User: Offer links to further resources and references
Loading

Possibly related PRs

Suggested reviewers

  • Adammatthiesen

📜 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 29ce305 and cb594a6.

📒 Files selected for processing (1)
  • src/content/docs/ko/start-here/environment-variables.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/content/docs/ko/start-here/environment-variables.mdx

🪧 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/start-here/environment-variables.mdx Localization changed, will be marked as complete.
ko/start-here/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: 1

🧹 Nitpick comments (3)
src/content/docs/ko/start-here/getting-started.mdx (3)

185-185: Specify the package manager operation type explicitly
The <PackageManagers> component in the manual installation section omits the type prop, which can lead to ambiguity. For clarity and consistency, add type="install".

- <PackageManagers pkg="@astrojs/db @astrojs/node studiocms" />
+ <PackageManagers type="install" pkg="@astrojs/db @astrojs/node studiocms" />

114-115: Replace JSX comments with HTML comments in MDX
MDX supports standard HTML comments (<!-- ... -->) more reliably than JSX‑style comments in non‑JSX contexts. To avoid potential rendering issues, convert:

- {/* <Steps> Note: For some reason this breaks placement of EC-Twoslash popups... must investigate */}
+ <!-- TODO: Investigate EC-Twoslash popup placement; clean up commented <Steps> when resolved -->

5-6: Normalize frontmatter indentation
The sidebar field’s indentation is inconsistent with typical YAML conventions (2 spaces). For readability and to avoid parsing issues, adjust:

- sidebar:
-    order: 1
+ sidebar:
+  order: 1
📜 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 29ce305.

📒 Files selected for processing (1)
  • src/content/docs/ko/start-here/getting-started.mdx (1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.21.2)
src/content/docs/ko/start-here/getting-started.mdx

60-60: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

Comment thread src/content/docs/ko/start-here/getting-started.mdx
coderabbitai[bot]
coderabbitai Bot previously approved these changes Apr 17, 2025
@Adammatthiesen
Copy link
Copy Markdown
Member

2025-Apr-17 03:22:17.733525
#13 205.4  validating links
2025-Apr-17 03:22:17.733525
#13 205.4 03:22:14 [ERROR] ✗ Found 1 invalid link in 1 file.
2025-Apr-17 03:22:17.733525
#13 205.4 03:22:14 ▶ ko/start-here/environment-variables/
2025-Apr-17 03:22:17.733525
#13 205.4 03:22:14   └─ /ko/start-here/getting-started/#optional-configure-oauth-authentication - invalid hash

Error for the record... 😅 How does Astro usually handle these situations @jsparkdev ? I'm a bit new to the whole links validator and i18n with starlight

@jsparkdev
Copy link
Copy Markdown
Contributor Author

@Adammatthiesen

Thanks for letting me know.
I have fixed the incorrect link in that file.

@Adammatthiesen Adammatthiesen merged commit a5b9141 into withstudiocms:main Apr 17, 2025
8 checks passed
@jsparkdev jsparkdev deleted the getting-started branch April 17, 2025 06:43
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