Skip to content

docs: align TRD with rehearsal domain model#25

Merged
seonghobae merged 2 commits into
developfrom
docs/trd-rehearsal-domain-alignment
Mar 11, 2026
Merged

docs: align TRD with rehearsal domain model#25
seonghobae merged 2 commits into
developfrom
docs/trd-rehearsal-domain-alignment

Conversation

@seonghobae
Copy link
Copy Markdown
Owner

Summary

  • update the TRD-equivalent docs to match the broadened rehearsal-analysis product scope
  • add a dedicated rehearsal domain model covering per-role harmony, cues, confidence, exports, and rehearsal prioritization
  • align architecture, security, and repo-entry docs with the new technical scope while avoiding DAW/full-transcription promises

Verification

  • python3 scripts/checks/verify_docs.py

@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4aaa4e23-37d0-404a-85c6-9385da3a359d

📥 Commits

Reviewing files that changed from the base of the PR and between d9e1609 and c2cec73.

📒 Files selected for processing (7)
  • AGENTS.md
  • ARCHITECTURE.md
  • README.md
  • docs/architecture/overview.md
  • docs/architecture/rehearsal-domain-model.md
  • docs/brand-story.md
  • docs/security/app-security.md

Cache: Disabled due to Reviews > Disable Cache setting

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Summary by CodeRabbit

릴리스 노트

  • 문서 개선
    • BandScope 설명을 리허설 중심으로 확대: 역할별 화성, 구간별 로드맵, 템포/그루브·중복·전치/카포·연주 범위 및 단순화 안내 포함
    • 아키텍처·도메인 모델과 산출물(큐시트/차트) 문서화 확대
    • 브랜드·UX 문구 보강으로 실무적 리허설 안내 강조
    • 보안·내보내기 안전 규칙 및 신뢰도(컨피던스) 표기 지침 추가

Walkthrough

BandScope 문서가 리허설 중심 도메인 모델로 재작성되었습니다. 아키텍처·보안·브랜드 문서가 섹션/역할 기반 화성·큐·신뢰도·내보내기 규칙 등을 명시하도록 확장되었습니다. 코드나 런타임 변경은 없습니다.

Changes

Cohort / File(s) Summary
루트 레벨 문서
AGENTS.md, ARCHITECTURE.md, README.md
프로젝트 개요와 코드 스타일·거버넌스 항목을 리허설 중심 언어로 확장. 제품 목표·출력물 정의(역할별 화성, 큐, 신뢰도 등) 추가.
아키텍처 문서
docs/architecture/overview.md, docs/architecture/rehearsal-domain-model.md
새 아키텍처 개요 및 리허설 도메인 모델 파일 추가: 섹션→역할 모델, 프로비넌스·신뢰도 추적, 큐/차트 내보내기 규격을 서술.
브랜드 및 보안 문서
docs/brand-story.md, docs/security/app-security.md
브랜드 스토리와 앱 보안 문서에서 리허설 친화적 산출물(큐시트/차트, 악기별 안내)과 내보내기 안전 규칙(파생 데이터 정제, 스크립트 불허)을 명문화.

Sequence Diagram(s)

(생성 조건에 부합하지 않아 생략함)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

개요

BandScope의 리허설 중심 분석 모델과 도메인 구조를 정의하는 포괄적인 문서 업데이트입니다. 아키텍처, 보안, 브랜드 지침 및 리허설 도메인 모델에 대한 새로운 설명서를 추가하여 제품의 목표와 개념을 명확히 합니다.

변경 사항

코호트 / 파일 요약
루트 레벨 문서
AGENTS.md, ARCHITECTURE.md, README.md
프로젝트 개요, 보안/거버넌스 규칙, 코드 스타일 지침을 리허설 중심 관점으로 확장. BandScope의 리허설 친화적 출력물(화성 추출, 섹션 로드맵, 신뢰도 표시, 음역대)에 대한 설명 추가.
아키텍처 문서
docs/architecture/overview.md, docs/architecture/rehearsal-domain-model.md
새로운 아키텍처 개요 및 상세 리허설 도메인 모델 문서 추가. 제품 기능 범위, 분석 대상 모델, 리허설 출력물, 공유 도메인 계약(섹션/역할 구조), 신뢰도/편집 추적, CI/CD 흐름 등을 정의.
브랜드 및 보안 문서
docs/brand-story.md, docs/security/app-security.md
BandScope을 실습 중심 어시스턴트로 재포지셔닝. 역할별 화성 감지, 형식/느낌 추출, 신뢰도 시각화, 리허설 큐시트 및 차트 스타일 내보내기 강조. 내보내기 안전성 규칙 확장.

예상 코드 리뷰 노력

🎯 3 (Moderate) | ⏱️ ~20 minutes

🐰 문서의 정원을 가꾸며
리허설의 길을 밝히네
역할별 화성, 신뢰도 뚜렷이
밴드의 실전을 돕는 글말
새로운 구조로 이루어진 안내서

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed 제목은 주요 변경 사항인 TRD(Technical Requirements Document)와 리허설 도메인 모델의 정렬을 명확하게 설명하며, 모든 문서 업데이트가 이 목표와 관련이 있습니다.
Description check ✅ Passed 설명은 TRD 업데이트, 리허설 도메인 모델 추가, 아키텍처/보안/문서 정렬이라는 실제 변경 사항들과 직접 관련이 있으며, 검증 단계도 포함하고 있습니다.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/trd-rehearsal-domain-alignment

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

@seonghobae seonghobae enabled auto-merge March 11, 2026 09:17
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 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.

@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai pause

@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai resume

@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai resolve

@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

✅ Actions performed

Full review triggered.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@ARCHITECTURE.md`:
- Line 50: The sentence "BandScope is not only a shell around chord labels,
stems, and ranges." should be rephrased to a positive, rehearsal-focused tone;
locate the phrase containing "BandScope" and replace the negative framing with a
constructive one such as "BandScope surfaces chord labels, stems, and ranges
while also providing rehearsal-focused tools for..." or "BandScope goes beyond
chord labels, stems, and ranges to support practical rehearsal workflows."
Ensure the new phrasing emphasizes usefulness and friendliness consistent with
the coding/document tone guidelines.

In `@README.md`:
- Around line 3-5: The opening long sentence starting with "BandScope is a
public GitHub project..." is overly dense; split it into shorter sentences or
two short paragraphs by extracting key features into 2–4 concise sentences
(e.g., one sentence describing core purpose and another listing main
capabilities like harmony-by-section, stems, tempo cues, transposition guidance)
and keep the follow-up sentence "It does not promise notation-grade..." as a
separate short sentence; update the README's first paragraph accordingly to
improve readability and friendly tone.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: f26131da-f43d-4ddd-9ed7-d293f23c567a

📥 Commits

Reviewing files that changed from the base of the PR and between d9e1609 and c2cec73.

📒 Files selected for processing (7)
  • AGENTS.md
  • ARCHITECTURE.md
  • README.md
  • docs/architecture/overview.md
  • docs/architecture/rehearsal-domain-model.md
  • docs/brand-story.md
  • docs/security/app-security.md

Comment thread ARCHITECTURE.md
Comment thread README.md
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

✅ Actions performed

Reviews paused.

@seonghobae seonghobae merged commit 8537a2e into develop Mar 11, 2026
16 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

✅ Actions performed

Comments resolved and changes approved.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

✅ Actions performed

Reviews resumed.

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