Skip to content

Commit afeb3e2

Browse files
docs: add AI-ready documentation (llms.txt, llms-full.txt)
- llms.txt: 사용자 가이드 (API, 전체 이벤트 목록 및 Record 필드) - llms-full.txt: 기여자 가이드 (아키텍처, 프로토콜, 디코더, 빌드) - README.md: AI 지원 문서 섹션 및 별 이모지 추가
1 parent 33ffbc2 commit afeb3e2

File tree

3 files changed

+1601
-1
lines changed

3 files changed

+1601
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,11 +278,22 @@ v0.5.0부터 `connectToChat()`이 반환하는 `CompletableFuture`는 연결이
278278

279279
...그 외 83개 이벤트 타입 지원. 전체 목록은 `ChatEvent.java`를 참조하세요.
280280

281+
## AI 지원 문서
282+
283+
이 프로젝트는 LLM/AI 도구가 코드베이스를 빠르게 이해할 수 있도록 AI-ready 문서를 제공합니다.
284+
285+
- [`llms.txt`](llms.txt) — 라이브러리 사용자를 위한 간결한 API 가이드
286+
- [`llms-full.txt`](llms-full.txt) — 기여자를 위한 아키텍처·내부 구조 전체 레퍼런스
287+
288+
AI 코딩 도구(Cursor, Claude Code, GitHub Copilot 등)와 함께 작업할 때, 프롬프트에 아래 내용을 포함하면 더 정확한 코드를 생성할 수 있습니다:
289+
290+
> 이 프로젝트는 SOOP 채팅 API Java 라이브러리입니다. `llms.txt` 또는 `llms-full.txt` 파일을 참고하여 프로젝트의 구조, API, 이벤트 시스템을 이해한 후 작업해 주세요.
291+
281292
## 기여하기
282293

283294
기여는 언제나 환영합니다! Pull Request를 제출해 주세요.
284295

285-
이 프로젝트가 도움이 되셨다면, 별을 눌러주세요. 감사합니다!
296+
이 프로젝트가 도움이 되셨다면, 별을 눌러주세요. 감사합니다!
286297

287298
## 라이선스
288299

0 commit comments

Comments
 (0)