Skip to content

[Docs] README를 실제 구현 상태에 맞게 수정 #71

Merged
zweadfx merged 1 commit intomainfrom
zweadfx-patch-1
Mar 18, 2026
Merged

[Docs] README를 실제 구현 상태에 맞게 수정 #71
zweadfx merged 1 commit intomainfrom
zweadfx-patch-1

Conversation

@zweadfx
Copy link
Copy Markdown
Owner

@zweadfx zweadfx commented Mar 18, 2026

어떤 변경사항인가요?

README.md를 실제 구현 상태에 맞게 수정하여 문서와 코드 간 불일치를 해소합니다.

작업 상세 내용

  • 각 기능에 실제 에이전트명과 노드 흐름 명시 (CoachAgent, GearAgent, JudgeAgent 등)
  • The Whistle에서 미구현 KBL 규정 참조 삭제 (FIBA/NBA만 지원)
  • System Architecture: 미사용 Router 분기 + Self-Correction 루프 설명 제거, 실제 구조(엔드포인트 → 전용 에이전트 직접 호출)로 교체
  • Architecture ASCII 다이어그램 추가
  • GitHub URL placeholder(your-username) → 실제 계정으로 수정
  • Getting Started에서 프론트엔드 설치 단계 제거 (별도 레포)

체크리스트

  • self-test를 수행하였는가?
  • 관련 문서나 주석을 업데이트하였는가?
  • 설정한 코딩 컨벤션을 준수하였는가?

관련 이슈

  • 관련 이슈:

리뷰 포인트

README의 Architecture 섹션이 실제 코드 흐름을 정확히 반영하는지 확인 부탁드립니다. 특히 workflow.py의 Router가 엔드포인트에서 사용되지 않는 점을 반영하여 아키텍처
설명을 전면 교체했습니다.

참고사항 및 스크린샷(선택)

변경 전후 주요 차이:

항목 Before After
Features 수식어 중심 설명 에이전트명 + 노드 흐름 명시
Whistle FIBA/NBA/KBL FIBA/NBA
Architecture Router 분기 + Self-Correction 전용 에이전트 직접 호출 파이프라인
GitHub URL your-username zweadfx
Getting Started 프론트엔드 포함 백엔드만

Summary by CodeRabbit

  • Documentation
    • Enhanced README with clearer feature descriptions, system architecture overview, and improved formatting.
    • Updated installation and quickstart instructions with current repository information and simplified guidance.

Updated README to improve clarity and formatting, including changes to feature descriptions and installation instructions.
@zweadfx zweadfx self-assigned this Mar 18, 2026
@zweadfx zweadfx added the docs 문서 작업이나 주석 수정 시 사용합니다. label Mar 18, 2026
@zweadfx
Copy link
Copy Markdown
Owner Author

zweadfx commented Mar 18, 2026

@CodeRabbit review

2 similar comments
@zweadfx
Copy link
Copy Markdown
Owner Author

zweadfx commented Mar 18, 2026

@CodeRabbit review

@zweadfx
Copy link
Copy Markdown
Owner Author

zweadfx commented Mar 18, 2026

@CodeRabbit review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

1 similar comment
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Documentation update to README.md with Markdown formatting improvements, reworded MVP feature descriptions including agent names and workflows, expanded System Architecture section describing LangGraph StateGraph multi-node pipeline, and updated installation repository URL.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Replaced HTML formatting with Markdown emphasis, reworded MVP features with agent workflows and state-machine details, expanded System Architecture section to describe LangGraph StateGraph multi-node pipeline with ASCII flow diagram, updated installation clone URL, and added agent-specific workflow definitions (CoachAgent, WeeklyCoachAgent, GearAgent, JudgeAgent).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Markdown hops where HTML stood still,
StateGraphs and agents bend to our will,
Documentation blooms like springtime clover,
LangGraph pipelines help us think it over—
Workflows refined with care! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title '[Docs] README를 실제 구현 상태에 맞게 수정' is directly related to the main change: updating README.md documentation to match the actual implementation state, removing discrepancies, and clarifying agent names and architecture details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch zweadfx-patch-1
📝 Coding Plan
  • Generate coding plan for human review comments

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 18, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@zweadfx zweadfx merged commit 3b94eb8 into main Mar 18, 2026
2 checks passed
@zweadfx zweadfx deleted the zweadfx-patch-1 branch March 18, 2026 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서 작업이나 주석 수정 시 사용합니다.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant