Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Standardize technical terms to English in guides/examples Korean documentation #794

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Gaic4o
Copy link
Contributor

@Gaic4o Gaic4o commented Feb 3, 2025

Background

Updated technical terms from Korean to English in the guides/examples pages for consistency and better understanding.

Changes Made

  • Standardized technical terms to English in the following pages:
    • guides/examples/auth.md
    • guides/examples/page-layout.md
    • guides/examples/types.md

@@ -28,9 +28,9 @@ sidebar_position: 1

로그인과 회원가입 컴포넌트를 별도로 만들고, 필요에 따라 index 파일에서 export 할 수 있습니다. 이 컴포넌트들은 사용자로부터 로그인 정보을 입력받는 폼을 포함합니다.

### 로그인 다이얼로그 만들기
### 로그인 widget 만들기
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: I think this is not intended — the original title is "Dialog for login", there was no intention to reference the FSD Widget

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I missed this part, I'll reflect it. Thank you.

@@ -90,11 +90,11 @@ export function RegisterPage() {

## 로그인 정보 전송 방법

로그인 정보를 백엔드 서버로 전송하기 위한 요청 함수를 작성하세요. 이 함수는 상태 관리 라이브러리나 뮤테이션 라이브러리(예: TanStack Query)를 사용하여 호출할 수 있습니다.
로그인 정보를 백엔드 서버로 전송하기 위한 요청 함수를 작성하세요. 이 함수는 상태 관리 라이브러리나 mutation 라이브러리(예: TanStack Query)를 사용하여 호출할 수 있습니다.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: why did you include "mutation" in the list of terms? It seems to me like a general concept from computer science that might be more understandable when translated

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You raise a good point. "뮤테이션" is just a phonetic translation of "mutation". Instead of this transliteration, we should explain what mutation means in TanStack Query's context.

Copy link
Contributor Author

@Gaic4o Gaic4o Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since "mutation" specifically refers to useMutation, I think we should explicitly mention this in the example. I suggest adding (e.g., TanStack Query's useMutation) to make the technical reference clearer.

How does this suggestion sound? Am I on the right track here?

@Gaic4o Gaic4o requested a review from illright February 5, 2025 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants