Skip to content

[DOCS] 문서 체계 개편 - #513

Merged
i-meant-to-be merged 14 commits into
developfrom
docs/#511
Sep 29, 2026
Merged

i-meant-to-be merged 14 commits into
developfrom
docs/#511

Conversation

@i-meant-to-be

Copy link
Copy Markdown
Contributor

🚩 연관 이슈

Closes #511

📝 작업 내용

문서 체계 개편

  • docs/CONSTITUTION.md를 최상위 원칙으로 이전하고 기존 Speckit 헌법을 제거함.
  • docs/README.md에 현재 기술·계층 지도, 상세 계약의 소유 범위, 작업별 읽기 경로를 정리함.
  • docs/architecture/ 5개 문서와 docs/conventions/ 5개 문서에 코드에 근거한 계약과 작성 규칙을 정리함.
  • AGENTS.md에 문서 우선순위와 실행 절차, 이슈 레이블에 따른 브랜치 형식을 명시함.
  • 기존 기능 문서 3개를 삭제하고 새 체계로 이전하지 않기로 한 범위를 유지함.
  • 이 브랜치의 선행 커밋에 포함된 Speckit 명령·스크립트와 불필요한 스킬 정리도 PR 변경 사항에 포함됨.

코드 경로 정합성

  • 공용 타입 파일 2개를 src/type/에서 src/types/로 이동하고 import 경로를 갱신함.
  • 오래된 문서 경로를 가리키던 주석을 제거함. 기능 동작 변경은 없음.

범위와 검증

  • plan.md는 PR의 파일 변경 목록에서 제외하고 로컬 작업 파일로 보관함.
  • conventions.md, criteria.md, document-system.md는 선행 커밋에서 추가된 참고 자료이며, 이번 작업에서는 수정하지 않았음. 병합 전에 사용자가 삭제하기로 한 파일임.
  • README.md 공개 안내 갱신과 분석·워크플로 문서는 이번 작업 범위에서 제외함. GA4와 Amplitude의 병행 운영 정책은 변경하지 않음.
  • 문서 길이·상대 링크·삭제 문서 참조·Markdown 형식을 확인하고 git diff --check를 통과함.
  • npm run lint를 통과함. 기존 src/util/sentry.test.ts의 Prettier 경고 1건이 남음.
  • vitest run --maxWorkers=4 --silent --reporter=dot에서 57개 파일, 535개 테스트를 통과함.
  • 기본 npm run build는 기존 dist/ 파일 삭제 권한 오류(EPERM)로 완료하지 못함. 별도 출력 경로를 사용한 vite build --outDir .verification-build는 통과했으며 임시 결과물을 제거함.

🏞️ 스크린샷 (선택)

UI 변경 없음.

🗣️ 리뷰 요구사항 (선택)

  • 헌법 → 문서 지도 → 상세 계약의 책임 경계와 코드 근거가 맞는지 확인 부탁함.
  • src/types/ 이동 후 import 경로와 타입 검사 결과를 확인 부탁함.
  • 참고 자료 3개(conventions.md, criteria.md, document-system.md)는 병합 전 사용자 삭제 예정임. 루트 README.md도 사용자가 직접 갱신할 예정임.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Too many files!

This PR contains 185 files, which is 85 over the limit of 100.

To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch.

Upgrade to a paid plan to raise the limit.

This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: ac25f342-d6f2-4228-bd44-638dc7fb3309

📥 Commits

Reviewing files that changed from the base of the PR and between 5f809a4 and 97bb9b9.

📒 Files selected for processing (185)
  • .agent/codex/evaluate.md
  • .agent/codex/how-to-use.md
  • .agent/codex/implement.md
  • .agent/gemini/analyze.md
  • .agent/gemini/clarify.md
  • .agent/gemini/evaluate.md
  • .agent/gemini/feature-request-template.md
  • .agent/gemini/how-to-use.md
  • .agent/gemini/plan.md
  • .agent/gemini/specify.md
  • .agent/gemini/tasks.md
  • .agent/workflows/pr-develop.md
  • .agent/workflows/speckits-analyze.md
  • .agent/workflows/speckits-checklist.md
  • .agent/workflows/speckits-clarify.md
  • .agent/workflows/speckits-constitution.md
  • .agent/workflows/speckits-implement.md
  • .agent/workflows/speckits-plan.md
  • .agent/workflows/speckits-specify.md
  • .agent/workflows/speckits-tasks.md
  • .agent/workflows/speckits-taskstoissues.md
  • .agents/skills/frontend-fundamentals/SKILL.md
  • .agents/skills/remotion-best-practices/SKILL.md
  • .agents/skills/remotion-best-practices/rules/3d.md
  • .agents/skills/remotion-best-practices/rules/animations.md
  • .agents/skills/remotion-best-practices/rules/assets.md
  • .agents/skills/remotion-best-practices/rules/assets/charts-bar-chart.tsx
  • .agents/skills/remotion-best-practices/rules/assets/text-animations-typewriter.tsx
  • .agents/skills/remotion-best-practices/rules/assets/text-animations-word-highlight.tsx
  • .agents/skills/remotion-best-practices/rules/audio-visualization.md
  • .agents/skills/remotion-best-practices/rules/audio.md
  • .agents/skills/remotion-best-practices/rules/calculate-metadata.md
  • .agents/skills/remotion-best-practices/rules/can-decode.md
  • .agents/skills/remotion-best-practices/rules/charts.md
  • .agents/skills/remotion-best-practices/rules/compositions.md
  • .agents/skills/remotion-best-practices/rules/display-captions.md
  • .agents/skills/remotion-best-practices/rules/extract-frames.md
  • .agents/skills/remotion-best-practices/rules/ffmpeg.md
  • .agents/skills/remotion-best-practices/rules/fonts.md
  • .agents/skills/remotion-best-practices/rules/get-audio-duration.md
  • .agents/skills/remotion-best-practices/rules/get-video-dimensions.md
  • .agents/skills/remotion-best-practices/rules/get-video-duration.md
  • .agents/skills/remotion-best-practices/rules/gifs.md
  • .agents/skills/remotion-best-practices/rules/images.md
  • .agents/skills/remotion-best-practices/rules/import-srt-captions.md
  • .agents/skills/remotion-best-practices/rules/light-leaks.md
  • .agents/skills/remotion-best-practices/rules/lottie.md
  • .agents/skills/remotion-best-practices/rules/maps.md
  • .agents/skills/remotion-best-practices/rules/measuring-dom-nodes.md
  • .agents/skills/remotion-best-practices/rules/measuring-text.md
  • .agents/skills/remotion-best-practices/rules/parameters.md
  • .agents/skills/remotion-best-practices/rules/sequencing.md
  • .agents/skills/remotion-best-practices/rules/sfx.md
  • .agents/skills/remotion-best-practices/rules/subtitles.md
  • .agents/skills/remotion-best-practices/rules/tailwind.md
  • .agents/skills/remotion-best-practices/rules/text-animations.md
  • .agents/skills/remotion-best-practices/rules/timing.md
  • .agents/skills/remotion-best-practices/rules/transcribe-captions.md
  • .agents/skills/remotion-best-practices/rules/transitions.md
  • .agents/skills/remotion-best-practices/rules/transparent-videos.md
  • .agents/skills/remotion-best-practices/rules/trimming.md
  • .agents/skills/remotion-best-practices/rules/videos.md
  • .agents/skills/remotion-best-practices/rules/voiceover.md
  • .agents/skills/vercel-composition-patterns/SKILL.md
  • .agents/skills/vercel-react-best-practices/SKILL.md
  • .claude/commands/pr-develop.md
  • .claude/commands/speckits/analyze.md
  • .claude/commands/speckits/checklist.md
  • .claude/commands/speckits/clarify.md
  • .claude/commands/speckits/constitution.md
  • .claude/commands/speckits/implement.md
  • .claude/commands/speckits/plan.md
  • .claude/commands/speckits/specify.md
  • .claude/commands/speckits/tasks.md
  • .claude/commands/speckits/taskstoissues.md
  • .claude/skills/frontend-fundamentals
  • .claude/skills/remotion-best-practices
  • .claude/skills/vercel-composition-patterns
  • .claude/skills/vercel-react-best-practices
  • .codex/prompts/analyze.md
  • .codex/prompts/checklist.md
  • .codex/prompts/clarify.md
  • .codex/prompts/implement.md
  • .codex/prompts/plan.md
  • .codex/prompts/specify.md
  • .codex/prompts/tasks.md
  • .gitignore
  • .specify/memory/constitution.md
  • .specify/scripts/bash/check-prerequisites.sh
  • .specify/scripts/bash/common.sh
  • .specify/scripts/bash/create-new-feature.sh
  • .specify/scripts/bash/setup-plan.sh
  • .specify/scripts/bash/update-agent-context.sh
  • .specify/templates/agent-file-template.md
  • .specify/templates/checklist-template.md
  • .specify/templates/plan-template.md
  • .specify/templates/spec-template.md
  • .specify/templates/tasks-template.md
  • AGENTS.md
  • README.md
  • docs/CONSTITUTION.md
  • docs/README.md
  • docs/analytics-dashboard.md
  • docs/architecture/app-routing-i18n.md
  • docs/architecture/data-access.md
  • docs/architecture/errors-observability.md
  • docs/architecture/realtime.md
  • docs/architecture/structure-and-ui.md
  • docs/conventions/data-and-realtime.md
  • docs/conventions/docs.md
  • docs/conventions/react-and-ui.md
  • docs/conventions/testing-and-storybook.md
  • docs/conventions/typescript-and-structure.md
  • docs/live-share-timer-sync.md
  • docs/local-backend-login.md
  • src/apis/apis/debateTable.ts
  • src/apis/apis/poll.ts
  • src/apis/requests/debateTable.ts
  • src/apis/responses/debateTable.ts
  • src/apis/responses/live.ts
  • src/apis/responses/member.ts
  • src/apis/responses/organization.ts
  • src/apis/responses/poll.ts
  • src/apis/sockets/type.ts
  • src/constants/sample_table.ts
  • src/hooks/mutations/useAddDebateTable.ts
  • src/hooks/mutations/usePostVoterPollInfo.ts
  • src/hooks/mutations/usePutDebateTable.ts
  • src/hooks/useFullscreen.ts
  • src/page/AudienceSharePage/components/AudienceNormalTimer.tsx
  • src/page/AudienceSharePage/components/AudienceTimeBasedTimer.tsx
  • src/page/AudienceSharePage/components/AudienceTimeBasedTimerDisplay.tsx
  • src/page/AudienceSharePage/hooks/AudienceScreenState.test.ts
  • src/page/AudienceSharePage/hooks/AudienceScreenState.ts
  • src/page/AudienceSharePage/hooks/EventInterpreter.test.ts
  • src/page/AudienceSharePage/hooks/EventInterpreter.ts
  • src/page/AudienceSharePage/hooks/useAudienceShareState.test.ts
  • src/page/AudienceSharePage/hooks/useAudienceShareState.ts
  • src/page/AudienceSharePage/hooks/useAudienceTimeBasedCountdown.ts
  • src/page/DebateVoteResultPage/DebateVoteResultPage.tsx
  • src/page/DebateVoteResultPage/components/VoteBar.tsx
  • src/page/DebateVoteResultPage/components/WinnerCard.tsx
  • src/page/LandingPage/components/TemplateCard.tsx
  • src/page/LandingPage/components/TemplateList.tsx
  • src/page/TableComposition/TableCompositionPage.tsx
  • src/page/TableComposition/components/TableNameAndType/TableNameAndType.test.tsx
  • src/page/TableComposition/components/TableNameAndType/TableNameAndType.tsx
  • src/page/TableComposition/components/TimeBox/TimeBox.tsx
  • src/page/TableComposition/components/TimeBoxManageButtons/TimeBoxManageButtons.stories.tsx
  • src/page/TableComposition/components/TimeBoxManageButtons/TimeBoxManageButtons.tsx
  • src/page/TableComposition/components/TimeBoxStep/TimeBoxStep.tsx
  • src/page/TableComposition/components/TimerCreationContent/TimerCreationContent.tsx
  • src/page/TableComposition/hook/useTableFrom.tsx
  • src/page/TableListPage/components/Table.tsx
  • src/page/TableListPage/components/TableListPageContent.tsx
  • src/page/TableOverviewPage/TableOverviewPage.stories.tsx
  • src/page/TableOverviewPage/TableOverviewPage.tsx
  • src/page/TableOverviewPage/components/TeamSelectionModal/TeamSelectionModal.tsx
  • src/page/TableSharingPage/TableSharingPage.tsx
  • src/page/TimerPage/TimerPage.tsx
  • src/page/TimerPage/buildTimerPayloadForShare.ts
  • src/page/TimerPage/components/CircularTimer.tsx
  • src/page/TimerPage/components/NormalTimer.test.tsx
  • src/page/TimerPage/components/NormalTimer.tsx
  • src/page/TimerPage/components/RoundControlRow.test.tsx
  • src/page/TimerPage/components/RoundControlRow.tsx
  • src/page/TimerPage/components/TimeBasedTimer.tsx
  • src/page/TimerPage/components/TimerController.tsx
  • src/page/TimerPage/getRemainingTimeForShare.ts
  • src/page/TimerPage/hooks/useAnswerTimer.ts
  • src/page/TimerPage/hooks/useBellSound.ts
  • src/page/TimerPage/hooks/useTimerBackground.ts
  • src/page/TimerPage/hooks/useTimerPageState.ts
  • src/page/TimerPage/stories/NormalTimerTestPage.stories.tsx
  • src/page/TimerPage/stories/TimeBasedTimer.stories.tsx
  • src/page/VoteParticipationPage/VoteParticipationPage.tsx
  • src/page/VoteParticipationPage/components/VoteTeamButton.tsx
  • src/repositories/ApiDebateTableRepository.ts
  • src/repositories/DebateTableRepository.ts
  • src/repositories/SessionDebateTableRepository.ts
  • src/types/fullscreen.d.ts
  • src/types/type.ts
  • src/util/arrayEncoding.test.ts
  • src/util/arrayEncoding.ts
  • src/util/sessionStorage.ts

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@github-actions

Copy link
Copy Markdown

🚀 Preview 배포 완료!

환경 URL
Preview 열기
API Dev 환경

PR이 닫히면 자동으로 정리됩니다.

@i-meant-to-be i-meant-to-be self-assigned this Sep 29, 2026
@i-meant-to-be i-meant-to-be added docs 문서 관련 작업 chore 파일 내부가 아닌 파일 자체에 대한 변경 (디렉토리 이동, 파일 이름 변경, 파일 삭제 등) labels Sep 29, 2026
@i-meant-to-be
i-meant-to-be merged commit 6e7fac0 into develop Sep 29, 2026
3 checks passed
@github-actions

Copy link
Copy Markdown

🧹 Preview 배포가 정리되었습니다.

This branch was successfully deployed

2 active deployments
DEPLOY_DEV — 97bb9b96 Deployed Sep 29, 2026 by i-meant-to-be via build-and-deploy #191
PREVIEW_ENV — 97bb9b96 Deployed Sep 29, 2026 by i-meant-to-be via cleanup #39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore 파일 내부가 아닌 파일 자체에 대한 변경 (디렉토리 이동, 파일 이름 변경, 파일 삭제 등) docs 문서 관련 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] 문서 체계 개편

1 participant