Repository navigation
[Docs] README 작성 - #144
[Docs] README 작성#144
Conversation
|
Warning Review limit reached
Next review available in: 54 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. 📝 WalkthroughWalkthroughREADME.md에 TeachING 서비스 소개 문서를 추가했다. 주요 기능, 기술 스택, 아키텍처, 협업 규칙, 저장소 구조, 팀 구성 및 도메인별 API 명세를 포함한다. ChangesTeachING README 문서화
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 291: Update the README.md document version date represented by the “2026.
08. 13. ver.” entry to the actual publication or release date; if it is
intentionally future-dated, explicitly label it as a scheduled date.
- Line 161: Update all four team member profile <img> elements in README.md to
include an alt attribute containing the corresponding GitHub username, including
the images near the referenced lines.
- Line 7: README.md의 제목 계층을 수정하세요. `### URL 하나로 시작하는 AI 학습 관리 서비스`를 일반 굵은 문단으로
변경해 Line 3의 `#` 제목 다음에 잘못된 단계 건너뛰기가 발생하지 않도록 하세요.
- Line 203: Update the repository structure code block in README.md by adding
the text language identifier to its opening fence, ensuring it satisfies
markdownlint MD040 without changing the block contents.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 7c475c35-574a-48a0-8728-db10f160bb67
⛔ Files ignored due to path filters (2)
images/architecture.pngis excluded by!**/*.pngimages/teaching-overview.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
|
|
||
| <img src="images/teaching-overview.png" width="800" alt="TeachING overview" /> | ||
|
|
||
| ### URL 하나로 시작하는 AI 학습 관리 서비스 |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
제목 계층을 한 단계씩 증가시키세요.
Line 7의 ###는 Line 3의 #에서 두 단계 내려갑니다. markdownlint의 MD001 검사를 실패시킵니다. 이 문장이 부제목이면 일반 굵은 문단으로 변경하세요.
수정 예시
-### URL 하나로 시작하는 AI 학습 관리 서비스
+**URL 하나로 시작하는 AI 학습 관리 서비스**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### URL 하나로 시작하는 AI 학습 관리 서비스 | |
| **URL 하나로 시작하는 AI 학습 관리 서비스** |
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 7, README.md의 제목 계층을 수정하세요. `### URL 하나로 시작하는 AI 학습 관리
서비스`를 일반 굵은 문단으로 변경해 Line 3의 `#` 제목 다음에 잘못된 단계 건너뛰기가 발생하지 않도록 하세요.
Source: Linters/SAST tools
| <tr> | ||
| <td align="center" width="172"> | ||
| <a href="https://github.com/hwiyoon20010309"> | ||
| <img src="https://github.com/hwiyoon20010309.png" width="90" /><br/> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
팀원 프로필 이미지에 alt를 추가하세요.
현재 네 개의 이미지에 대체 텍스트가 없습니다. 각 이미지에 GitHub 사용자명을 alt로 추가하세요.
수정 예시
-<img src="https://github.com/hwiyoon20010309.png" width="90" />
+<img src="https://github.com/hwiyoon20010309.png" width="90" alt="`@hwiyoon20010309` 프로필" />
-<img src="https://github.com/Mymyseoyoung.png" width="90" />
+<img src="https://github.com/Mymyseoyoung.png" width="90" alt="`@Mymyseoyoung` 프로필" />
-<img src="https://github.com/m00nsh.png" width="90" />
+<img src="https://github.com/m00nsh.png" width="90" alt="`@m00nsh` 프로필" />
-<img src="https://github.com/EH-OI.png" width="90" />
+<img src="https://github.com/EH-OI.png" width="90" alt="`@EH-OI` 프로필" />Also applies to: 170-170, 179-179, 188-188
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 161-161: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 161, Update all four team member profile <img> elements in
README.md to include an alt attribute containing the corresponding GitHub
username, including the images near the referenced lines.
Source: Linters/SAST tools
|
|
||
| ## 📁 저장소 구조 | ||
|
|
||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
저장소 구조 코드 블록에 언어 식별자를 지정하세요.
markdownlint의 MD040 검사를 통과하도록 시작 fence에 text를 추가하세요.
수정 예시
-```
+```text📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 203-203: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 203, Update the repository structure code block in
README.md by adding the text language identifier to its opening fence, ensuring
it satisfies markdownlint MD040 without changing the block contents.
Source: Linters/SAST tools
|
|
||
| **🧑🏫 TeachING** · Made with care by the TeachING-Dev team | ||
|
|
||
| <sub>2026. 08. 13. ver.</sub> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
문서 버전 날짜를 실제 기준일로 수정하세요.
작성일 또는 릴리스일을 의미한다면 2026. 08. 13.은 현재 날짜인 2026년 8월 12일보다 하루 뒤입니다. 실제 공개일을 사용하거나 예정일임을 명시하세요.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 291, Update the README.md document version date
represented by the “2026. 08. 13. ver.” entry to the actual publication or
release date; if it is intentionally future-dated, explicitly label it as a
scheduled date.
Mymyseoyoung
left a comment
Mymyseoyoung
left a comment
There was a problem hiding this comment.
감사합니당 ! 리포지토리 구조가 훨씬 파악하기 편해진거같아요
다만 아키텍처 다이어그램이 조금 수정되어야 할거같아서 제가 수정해서 보내드리겠습니다 ! 이후 반영 부탁드려요
나머지 소개 섹션과 역할 분담 등 꼼꼼히 적어주셨네요 !!
어떤 기능인가요?
프로젝트 최상위 README.md를 새로 작성
상세 내용
레포지토리에 README가 없어 서비스 개요·기술 스택·아키텍처·API 구조를 파악하기 어려운 문제를 해결하기 위해 다음 내용을 정리했습니다.
체크 리스트
로컬 테스트 완료
기타
Summary by CodeRabbit