Skip to content

i18n(ko-KR): create sdk.mdx#89

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

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

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 18, 2025

Description

create sdk.mdx

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Korean-language documentation for the StudioCMS SDK, including detailed overviews of its main features, namespaces, and usage examples.
    • Included information on both the standard and cached SDK variants, with code snippets and references for advanced usage.

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

coderabbitai Bot commented Apr 18, 2025

Walkthrough

A new documentation file in Korean has been introduced for the StudioCMS SDK. This file provides a structured overview of the SDK's main namespaces, functions, and usage examples, including both the standard SDK and its cached variant. The documentation explains how to import and utilize various components such as authentication, initialization, content retrieval, content modification, database access, REST API integration, and utility functions within Astro projects. The content is formatted as an Astro MDX file and includes i18n support.

Changes

File(s) Change Summary
src/content/docs/ko/how-it-works/sdk.mdx Added a comprehensive Korean-language documentation file for the StudioCMS SDK and its cached variant.

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

25-28: Unify object naming in descriptive text
The prose refers to studioCMSSDK and studioCMSSDKCached, but the code samples import them as SDK and SDKCached. To avoid confusion, update the narrative to mention SDK/SDKCached directly (for example, "SDK 객체" and "SDKCached 객체").

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9e8007b and a1f8ffc.

📒 Files selected for processing (1)
  • src/content/docs/ko/how-it-works/sdk.mdx (1 hunks)
⏰ 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/sdk.mdx (4)

9-9: Verify import alias resolution
The import path uses a leading tilde (~) in

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

Ensure that your Astro/MDX configuration defines ~ as a valid alias. If not, you may need to switch to a relative path or another alias (e.g. @src/ or ../components/).


17-24: Review code fence configuration
All snippets are marked with ````ts twoslash. Confirm that your MDX processor and syntax highlighter support the `twoslash` directive. If they don’t, consider using standard TypeScript fences (ts) or updating your plugin settings to enable Twoslash.


20-23: Confirm virtual module import syntax
You have:

import SDK from 'studiocms:sdk';
// 또는
import SDKCached from 'studiocms:sdk/cache';

Make sure the studiocms: prefix is properly defined as a virtual module in your build setup (Vite/Astro). If it’s mis‑configured, consumers might need to adjust these paths.


292-295: Verify anchor link for SDK.db
The last <ReadMore> links to #sdkdb. Depending on your slug generation rules, the heading ### SDK.db might slugify differently (e.g. sdkdb vs skddb). Please confirm the correct anchor or make it explicit to prevent broken links.

@Adammatthiesen Adammatthiesen merged commit bca23c3 into withstudiocms:main Apr 18, 2025
8 checks passed
@jsparkdev jsparkdev deleted the sdk branch April 18, 2025 13:49
Adammatthiesen pushed a commit that referenced this pull request Apr 18, 2025
Adammatthiesen added a commit that referenced this pull request Apr 20, 2025
* start of beta.16 docs

* add updated label in sidebar

* add run to npm command

* add new guides

* update translations

* add upgrade docs

* link to self-hosted guide

* update links

* add skip2 to sidebar

* update landing page video

* add: translations mini guide

* fix link

* update file structure

* update badge

* add process info and notes

* update

* remove unused dep

* fix changelogs

* cleanup

* update

* add sort order

* collapse the version guides by default

* relocate files

* update

* update links

* disable edit url for release notes

* fix

* update to pre-released versions

* Update guides descriptions and guide index

* add badge

* update

* fix spelling

* update deps

* update

* fix cap

* update

* test

* latest guide system

* attempt fix

* update lunaria

* fix?

* add exclude rule

* add note with coolify gist

* fix file structure

* add note

* update link

* make more dynamic

* update url

* update submodule to main

* update

* fix knip

* update

* update to use new studiocms add command

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* cleanup

* update

* Update src/content/docs/en/how-it-works/cli.mdx

Co-authored-by: Armand Philippot <git@armand.philippot.eu>

* Update src/content/docs/en/guides/contributing/translations.mdx

Co-authored-by: Armand Philippot <git@armand.philippot.eu>

* remove old link plugin

* fix

* fix wording

* feat: specify that Crowdin is used for packages

Co-authored-by: Adam Matthiesen <amatthiesen@outlook.com>

* Apply suggestions from code review

Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com>

* Update src/content/docs/en/guides/contributing/translations.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* i18n(ko-KR): create `how-it-works/index.mdx` (#88)

* i18n(ko-KR): create `sdk.mdx` (#89)

* i18n(ko-KR): create `translations.mdx` (#90)

* fix

* update packages to official release status

---------

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com>
Co-authored-by: Junseong Park <39112954+jsparkdev@users.noreply.github.com>
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