Conversation
|
MATEBALL-STORYBOOK |
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
docs/trouble/suspense.md (1)
67-101: 볼드체 대신 서브-헤딩(###/####) 사용으로 MD036 경고 제거
markdownlint가 강조(볼드) 문법을 헤딩처럼 사용하는 패턴을 MD036(no-emphasis-as-heading) 규칙 위반으로 감지합니다.
문서 TOC 생성을 돕고 일관된 마크다운 스타일을 유지하려면 볼드 대신 서브-헤딩을 써 주세요.-**2-1. 훅과 컴포넌트 구조 분리** +#### 2-1. 훅과 컴포넌트 구조 분리 -**2-2. Mock -> API 전환이 자연스럽게 연결** +#### 2-2. Mock → API 전환이 자연스럽게 연결 -**2-3. 데이터 흐름의 일관성 확보** +#### 2-3. 데이터 흐름의 일관성 확보 -**2-4. React Hook 규칙 엄수** +#### 2-4. React Hook 규칙 엄수 -**2-5. Suspense로 데이터 로드 및 에러 처리 용이** +#### 2-5. Suspense로 데이터 로드 및 에러 처리 용이이렇게 수정하면 자동 TOC/사이드바에 항목이 노출되고 가독성도 향상됩니다.
docs/trouble/gradient.md (1)
22-28: 헤딩 내부의 볼드 문법을 서브-헤딩으로 교체
### **absolute → fixed**형태는 MD036 위반이며, 렌더링 시 굵게만 보이고 TOC에는 포함되지 않습니다.
아래처럼 수정해 주세요.-### **absolute → fixed** +#### absolute → fixed다른 유사 사례(“Foreground와 Background의 명확한 분리” 등)도 같이 정리해 주시면 좋겠습니다.
docs/trouble/useFunnel.md (1)
42-48: 소제목 번호와 실제 내용이 어긋나지 않도록 헤딩 사용 권장
### 1. 퍼널 구조 분리 및 navigate 활용처럼 번호를 헤딩에 직접 넣으면
다음에 문단 추가/삭제 시 번호를 모두 손으로 변경해야 합니다.
마크다운 자동 TOC도 숫자를 포함해 렌더링돼 과도하게 길어질 수 있습니다.권장:
-### 1. 퍼널 구조 분리 및 `navigate` 활용 +#### 퍼널 구조 분리 및 `navigate` 활용필요하다면 목록(1., 2., …)은 본문에서 관리하고 헤딩은 주제만 기록하세요.
docs/trouble/protectedRoute.md (3)
1-1: 첫 문장 어투 및 띄어쓰기 개선 제안
가독성을 위해 불필요한 띄어쓰기·쉼표를 제거하고 자연스러운 문장으로 다듬는 편이 좋습니다.-로그인 하지 않은 사용자가, 로그인 이후 접근 가능한 경로로 접속했을때는 splash 화면으로 이동 후 로그인 페이지로 가는 흐름 +로그인하지 않은 사용자가 로그인 이후 접근 가능한 경로에 접속했을 때에는 스플래시 화면으로 이동한 뒤 로그인 페이지로 리다이렉트되는 흐름
15-15: 불필요한 ‘까깜’ 문자열 제거
문장 끝에 남은 오타·불필요 텍스트를 제거해 주세요.-결과적으로 로그인 전, 로그인 후 화면 전환과 상태 반영이 비동기적으로 꼬여 흐름 제어가 어려웠다.까깜 +결과적으로 로그인 전·후 화면 전환과 상태 반영이 비동기적으로 꼬여 흐름 제어가 어려웠다.
24-24: 쉼표 위치 및 중복 공백 수정
문장 초반의 불필요한 쉼표 및 공백을 제거하면 읽기 수월합니다.-- 깜빡임 관련 해결 방법으로는 , 라우터에서 `AuthGuard`를 최상위 레벨로 배치해, 인증 여부 확인이 먼저 이루어지고 자식 라우트들이 렌더링 되도록 변경했다. 이를 통해 인증이 안 된 경우 자식 컴포넌트들의 API 요청 자체를 막았다. 또, 라우터에 `errorElement`를 빈 컴포넌트 또는 별도 에러 UI로 추가해 예외 상황을 자연스럽게 처리하도록 함으로써, 예기치 않은 에러 발생 시 사용자에게 불필요한 깜빡임을 보여주지 않도록 했다. `AuthGuard` 컴포넌트에서 인증 상태 로딩 중엔 스플래시 화면을 렌더링하고, 인증 실패 시 로그인 페이지로 즉시 리다이렉트하도록 개선해 사용자 경험을 부드럽게 만들었다. +- 깜빡임 관련 해결 방법으로는 라우터에서 `AuthGuard`를 최상위 레벨로 배치해 인증 여부 확인이 먼저 이루어지고 자식 라우트들이 렌더링되도록 변경했다. 이를 통해 인증이 안 된 경우 자식 컴포넌트들의 API 요청 자체를 막았다. 또, 라우터에 `errorElement`를 빈 컴포넌트 또는 별도 에러 UI로 추가해 예외 상황을 자연스럽게 처리하도록 함으로써, 예기치 않은 에러 발생 시 사용자에게 불필요한 깜빡임을 보여주지 않도록 했다. `AuthGuard` 컴포넌트에서 인증 상태 로딩 중엔 스플래시 화면을 렌더링하고, 인증 실패 시 로그인 페이지로 즉시 리다이렉트하도록 개선해 사용자 경험을 부드럽게 만들었다.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/trouble/image-1.pngis excluded by!**/*.pngdocs/trouble/image.pngis excluded by!**/*.png
📒 Files selected for processing (6)
docs/index.md(1 hunks)docs/trouble/gradient.md(1 hunks)docs/trouble/index.md(1 hunks)docs/trouble/protectedRoute.md(1 hunks)docs/trouble/suspense.md(1 hunks)docs/trouble/useFunnel.md(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#84
File: src/shared/constants/icon-list.ts:28-31
Timestamp: 2025-07-08T20:08:47.311Z
Learning: heesunee는 PR #84에서 chip 관련 컴포넌트 작업을 하지 않으므로, 쿼리와 API 관련 코드에만 집중해서 리뷰해야 합니다.
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#78
File: src/pages/sign-up/utils/age-calculate.ts:1-4
Timestamp: 2025-07-09T09:08:46.371Z
Learning: heesunee는 나이 계산 시 한국식 나이 시스템을 사용하므로, 정확한 생일 기반 계산보다는 출생연도 기준의 간단한 계산 방식을 선호합니다.
docs/trouble/index.md (1)
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#7
File: src/shared/routes/Router.tsx:4-4
Timestamp: 2025-06-29T18:02:42.616Z
Learning: The Home component file in the MATEBALL-CLIENT project was renamed from Home.tsx to home.tsx, so the correct import path is '@pages/home/home'.
docs/trouble/useFunnel.md (2)
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#94
File: src/pages/sign-up/sign-up.tsx:4-4
Timestamp: 2025-07-09T17:24:19.755Z
Learning: heesunee는 src/pages/sign-up/sign-up.tsx의 isNicknameStep 하드코딩된 값을 퍼널 패턴으로 카카오 통합과 함께 나중에 처리할 예정이므로, 이 부분에 대해 다시 언급하지 않아야 합니다.
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#95
File: src/pages/sign-up/components/nickname-step.tsx:28-30
Timestamp: 2025-07-09T18:07:41.693Z
Learning: heesunee는 src/pages/sign-up/components/nickname-step.tsx의 onSubmit 핸들러 API 호출을 쿼리와 함께 통합해서 처리할 예정이므로, 이 부분에 대해 다시 언급하지 않아야 합니다.
docs/trouble/protectedRoute.md (2)
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#94
File: src/pages/sign-up/sign-up.tsx:4-4
Timestamp: 2025-07-09T17:24:19.755Z
Learning: heesunee는 src/pages/sign-up/sign-up.tsx의 isNicknameStep 하드코딩된 값을 퍼널 패턴으로 카카오 통합과 함께 나중에 처리할 예정이므로, 이 부분에 대해 다시 언급하지 않아야 합니다.
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#95
File: src/pages/sign-up/components/nickname-step.tsx:28-30
Timestamp: 2025-07-09T18:07:41.693Z
Learning: heesunee는 src/pages/sign-up/components/nickname-step.tsx의 onSubmit 핸들러 API 호출을 쿼리와 함께 통합해서 처리할 예정이므로, 이 부분에 대해 다시 언급하지 않아야 합니다.
docs/trouble/suspense.md (2)
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#94
File: src/pages/sign-up/sign-up.tsx:4-4
Timestamp: 2025-07-09T17:24:19.755Z
Learning: heesunee는 src/pages/sign-up/sign-up.tsx의 isNicknameStep 하드코딩된 값을 퍼널 패턴으로 카카오 통합과 함께 나중에 처리할 예정이므로, 이 부분에 대해 다시 언급하지 않아야 합니다.
Learnt from: heesunee
PR: MATEBALL/MATEBALL-CLIENT#95
File: src/pages/sign-up/components/nickname-step.tsx:28-30
Timestamp: 2025-07-09T18:07:41.693Z
Learning: heesunee는 src/pages/sign-up/components/nickname-step.tsx의 onSubmit 핸들러 API 호출을 쿼리와 함께 통합해서 처리할 예정이므로, 이 부분에 대해 다시 언급하지 않아야 합니다.
🪛 markdownlint-cli2 (0.17.2)
docs/trouble/suspense.md
67-67: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
84-84: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
88-88: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
101-101: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
docs/index.md (1)
12-14: 링크 경로 형식이 섹션 내부와 불일치합니다여기서는
/trouble/index.md를 지정했지만,docs/trouble/index.md내부 액션 버튼들은 확장자 없이/trouble/xxx형태를 사용합니다.
빌드 파이프라인/라우터 설정에 따라.md포함 여부가 중요할 수 있으므로, 한쪽으로 통일해 주세요.예시:
-link: /trouble/index.md +link: /troubledocs/trouble/index.md (1)
8-19: 하위 문서 링크 경로 일관성 검토액션 버튼들이
.md확장자를 생략한 절대 경로(/trouble/gradient)를 사용합니다.
앞서docs/index.md에서는.md가 포함되어 있어 두 곳이 서로 다른 규칙을 따릅니다.
정적 사이트 생성기가 자동으로 확장자를 보정하지 않으면 404가 날 수 있으니 확인 바랍니다.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#️⃣ Related Issue
Closes #299
💎 PR Point
너무 졸려서.. ㅎㅎ 한개씩만 업데이트 해놨어요 !! 우리의 수많은 트러블 슈팅들, 챌린징들, 아티클은 차근차근 추가해나가봅시다☺️ 🔥🍺
📸 Screenshot
Summary by CodeRabbit