Skip to content

docs: 리드미 초안 완성#180

Merged
Neibce merged 7 commits intomainfrom
docs/readme
Aug 24, 2025
Merged

docs: 리드미 초안 완성#180
Neibce merged 7 commits intomainfrom
docs/readme

Conversation

@Neibce
Copy link
Owner

@Neibce Neibce commented Aug 24, 2025

Summary by CodeRabbit

  • 문서(Documentation)
    • 제품 소개, 배경, 목표, 핵심 기능(건강 추적·정서 공유) 추가
    • 대상 사용자 분석, 경쟁 차별점, 사회적 가치·배포 계획 포함
    • 시스템 설계 개요와 기술 스택, CI/CD 흐름 개요 반영
    • 설치/빌드 가이드, 데모 영상 링크, 가격(월 2,900원)·수익화·제휴 전략 추가
    • 기능 명세(온보딩, 데이터 입력, 리마인더, 보상, 부모/자녀 UX)와 성과·테스트 결과 정리
    • 팀 구성 및 참여 회고 추가
    • 기존 템플릿/설정 안내 제거

@coderabbitai
Copy link

coderabbitai bot commented Aug 24, 2025

Walkthrough

이 PR은 기존 해커톤용 템플릿 README를 제품 스펙 중심의 README로 전면 교체하여 프로젝트 소개, 기능 명세, 아키텍처/기술스택, 설치/배포 가이드, 디렉터리 구조, 성과/테스트 결과, 팀 정보 등을 포함하는 단일 문서 갱신이다.

Changes

Cohort / File(s) Change Summary
Docs: Product README overhaul
README.md
템플릿 가이드를 제거하고 “온기(ONGI)” 제품 문서로 대체. 소개, 배경/목표, 기능 사양, 타깃/경쟁 분석, 사회적 가치/확산 계획, 시스템 설계(ERD/아키텍처), 기술스택, 디렉터리 구조, 설치/빌드 가이드(Android/iOS), 알림/CI·CD 언급, 수익화/가격, 성과/테스트, 팀/회고 추가.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

꼬물꼬물 깃발 흔들며, 토끼는 문서를 폈네
템플릿 옷 훌렁 벗고, 스펙의 숲을 채웠네
ERD 별빛 또르르, 아키텍처 달도 웃고
푸시 알림 살랑살랑, 배포 길도 반짝이고
온기 가득 README여, 뛰뛰빵빵 출발! 🐰✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

💡 Knowledge Base configuration:

  • Jira integration is disabled
  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 9512666 and 2a9b6ad.

📒 Files selected for processing (1)
  • README.md (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@Neibce Neibce merged commit dacdc88 into main Aug 24, 2025
4 checks passed
Neibce added a commit to 2025-PNU-SW-Hackathon/PNUSW-2025-OnGi-10 that referenced this pull request Aug 25, 2025
* Update README.md

* docs: 리드미 초안 작성 중...

* docs: 리드미 초안 작성 중...

* docs: 리드미 초안 작성 중...

* docs: 리드미 초안 작성 중...

* docs: 리드미 초안 작성 중...

* docs: 리드미 초안 작성 중...
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.

1 participant