Skip to content

Commit 5f8efd9

Browse files
ImGdevelImGdevel
committed
docs: 문서 파일 구조 변경 및 링크 수정
1 parent 3d45c42 commit 5f8efd9

File tree

15 files changed

+155
-166
lines changed

15 files changed

+155
-166
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
- **소유권 모델**: 시스템/공개/개인 캐릭터 권한 관리
6868
- **프롬프트 생성**: 설정 기반 SystemPrompt 구성
6969

70-
> **상세 구현**: 각 기능의 구체적인 코드 구현과 아키텍처는 [FEATURES.md](docs/FEATURES.md)를 참고하세요.
70+
> **상세 구현**: 각 기능의 구체적인 코드 구현과 아키텍처는 [features.md](docs/overview/features.md)를 참고하세요.
7171
7272
<br>
7373

‎docs/README.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# ProjectVG API Server 문서
2+
3+
ProjectVG API Server의 종합 문서 모음입니다. 각 카테고리별로 정리된 문서들을 통해 프로젝트의 모든 측면을 이해하고 활용할 수 있습니다.
4+
5+
## 📂 문서 구조
6+
7+
### 📋 [Overview](./overview/) - 프로젝트 개요
8+
프로젝트의 핵심 기능과 개발 표준에 대한 개요를 제공합니다.
9+
10+
- **[features.md](./overview/features.md)** - 핵심 기능 상세 가이드
11+
- 채팅 시스템 (WebSocket + HTTP)
12+
- 인증 시스템 (JWT + OAuth2)
13+
- 크레딧 시스템 (정밀 계산)
14+
- AI 캐릭터 관리 (하이브리드 설정)
15+
16+
- **[coding-standards.md](./overview/coding-standards.md)** - 코딩 컨벤션 및 표준
17+
- 네이밍 규칙
18+
- 프로젝트 구조
19+
- 코드 스타일 가이드
20+
21+
### 🏗️ [Architecture](./architecture/) - 시스템 아키텍처
22+
시스템의 기술적 아키텍처와 설계 패턴에 대한 문서입니다.
23+
24+
- **[websocket_connection_management.md](./architecture/websocket_connection_management.md)** - WebSocket 연결 관리 설계
25+
- **[websocket_http_architecture.md](./architecture/websocket_http_architecture.md)** - WebSocket + HTTP 하이브리드 아키텍처
26+
27+
### 🔌 [API](./api/) - API 참조
28+
REST API 엔드포인트와 사용법에 대한 상세 가이드입니다.
29+
30+
- **[rest-endpoints.md](./api/rest-endpoints.md)** - REST API 엔드포인트 레퍼런스
31+
- 인증 API
32+
- 채팅 API
33+
- 캐릭터 관리 API
34+
- 크레딧 시스템 API
35+
36+
### 🔗 [Integrations](./integrations/) - 외부 연동
37+
외부 서비스 및 클라이언트와의 연동 가이드입니다.
38+
39+
#### Unity 클라이언트 연동
40+
Unity 게임 엔진과의 연동을 위한 종합 가이드입니다.
41+
42+
- **[authentication-guide.md](./integrations/unity/authentication-guide.md)** - Unity OAuth2 인증 가이드
43+
- **[oauth2-implementation.md](./integrations/unity/oauth2-implementation.md)** - OAuth2 PKCE 구현 상세
44+
- **[oauth2-handler.md](./integrations/unity/oauth2-handler.md)** - OAuth2 핸들러 구현
45+
- **[cookie-handling.md](./integrations/unity/cookie-handling.md)** - 쿠키 처리 가이드
46+
47+
#### 외부 서비스 연동
48+
외부 AI 및 음성 서비스와의 API 연동 가이드입니다.
49+
50+
- **[memory-service.md](./integrations/external-services/memory-service.md)** - Memory Server API 연동
51+
- **[voice-service.md](./integrations/external-services/voice-service.md)** - Voice Server API 연동 (TTS)
52+
53+
#### LLM 서비스 연동
54+
언어 모델 서비스와의 연동 및 최적화 가이드입니다.
55+
56+
- **[prompt-engineering.md](./integrations/llm/prompt-engineering.md)** - 프롬프트 엔지니어링 가이드
57+
58+
### 🔐 [Security](./security/) - 보안
59+
보안 가이드라인과 베스트 프랙티스입니다.
60+
61+
- **[security-guidelines.md](./security/security-guidelines.md)** - 보안 가이드라인 및 베스트 프랙티스
62+
- JWT 토큰 보안
63+
- 데이터베이스 보안
64+
- 인증 플로우 보안
65+
- 프로덕션 보안 체크리스트
66+
67+
### 🚀 [Deployment](./deployment/) - 배포 및 운영
68+
배포, CI/CD, 운영 환경 설정에 대한 가이드입니다.
69+
70+
- **[ci-cd-setup.md](./deployment/ci-cd-setup.md)** - CI/CD 파이프라인 설정 가이드
71+
72+
## 🚀 빠른 시작
73+
74+
### 새로운 개발자를 위한 추천 읽기 순서
75+
76+
1. **프로젝트 이해**: [overview/features.md](./overview/features.md) - 전체 기능 파악
77+
2. **개발 환경**: [deployment/ci-cd-setup.md](./deployment/ci-cd-setup.md) - 환경 설정
78+
3. **코딩 표준**: [overview/coding-standards.md](./overview/coding-standards.md) - 개발 규칙
79+
4. **API 사용법**: [api/rest-endpoints.md](./api/rest-endpoints.md) - API 이해
80+
5. **보안 가이드**: [security/security-guidelines.md](./security/security-guidelines.md) - 보안 요구사항
81+
82+
### Unity 개발자를 위한 가이드
83+
84+
Unity 클라이언트 개발을 위해서는 다음 문서들을 순서대로 참고하세요:
85+
86+
1. [integrations/unity/authentication-guide.md](./integrations/unity/authentication-guide.md) - 인증 개요
87+
2. [integrations/unity/oauth2-implementation.md](./integrations/unity/oauth2-implementation.md) - OAuth2 구현
88+
3. [integrations/unity/oauth2-handler.md](./integrations/unity/oauth2-handler.md) - 핸들러 구현
89+
4. [integrations/unity/cookie-handling.md](./integrations/unity/cookie-handling.md) - 쿠키 관리
90+
91+
### 외부 서비스 연동 개발자를 위한 가이드
92+
93+
외부 AI 서비스와의 연동을 개발하는 경우:
94+
95+
1. [integrations/llm/prompt-engineering.md](./integrations/llm/prompt-engineering.md) - LLM 연동
96+
2. [integrations/external-services/memory-service.md](./integrations/external-services/memory-service.md) - 메모리 서비스
97+
3. [integrations/external-services/voice-service.md](./integrations/external-services/voice-service.md) - 음성 서비스
98+
99+
## 📚 추가 리소스
100+
101+
- **메인 프로젝트 문서**: [../CLAUDE.md](../CLAUDE.md) - 프로젝트 전체 가이드
102+
- **API 서버 코드**: [../](../) - 소스 코드 베이스
103+
- **테스트 가이드**: [../ProjectVG.Tests/](../ProjectVG.Tests/) - 테스트 코드
104+
105+
## 🤝 기여 가이드
106+
107+
문서 개선이나 추가가 필요한 경우:
108+
109+
1. 관련 카테고리의 적절한 폴더를 선택
110+
2. kebab-case 네이밍 컨벤션 사용
111+
3. 기존 문서 구조와 스타일 일관성 유지
112+
4. 상호 참조 링크 추가
113+
114+
---
115+
116+
💡 **도움이 필요하신가요?** 각 문서의 상세 내용을 확인하거나, 프로젝트 메인테이너에게 문의해주세요.

docs/api_reference.md renamed to docs/api/rest-endpoints.md

File renamed without changes.

docs/github-secrets-setup.md renamed to docs/deployment/ci-cd-setup.md

File renamed without changes.

docs/memory_server_api.md renamed to docs/integrations/external-services/memory-service.md

File renamed without changes.

docs/voice_server_api/README_ko.md renamed to docs/integrations/external-services/voice-service.md

File renamed without changes.

docs/prompt_engineering_guide.md renamed to docs/integrations/llm/prompt-engineering.md

File renamed without changes.

docs/unity_auth_guide.md renamed to docs/integrations/unity/authentication-guide.md

File renamed without changes.

docs/unity_cookie_handling.md renamed to docs/integrations/unity/cookie-handling.md

File renamed without changes.

docs/unity_oauth2_handler.md renamed to docs/integrations/unity/oauth2-handler.md

File renamed without changes.

0 commit comments

Comments
 (0)