Skip to content

Commit e65a19f

Browse files
crowrishclaude
andcommitted
refactor: Remove GitHub Pages and consolidate documentation in README
🗑️ Removed GitHub Pages: - Deleted entire docs/ folder (1000+ auto-generated files) - Removed Jekyll configuration files - Removed GitHub Pages setup documentation - Updated .gitignore to exclude docs/ folder 📖 Enhanced README.md: - Added comprehensive table of contents - Reorganized sections with clear structure - Updated "문서" section to "목차" with navigation links - Enhanced "링크" section with npm package and official docs - Updated version history to reflect documentation consolidation 🔧 Simplified Build Process: - Removed docs generation scripts from package.json - Kept only essential scripts: build, build:full, clean - Maintained API Extractor for compatibility tracking - Streamlined development workflow 🎯 Benefits: - Single source of truth for documentation - Faster loading and easier maintenance - Better GitHub repository navigation - Reduced complexity while keeping essential features 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f379d09 commit e65a19f

1,032 files changed

Lines changed: 33 additions & 35457 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,11 @@ public
9696
tmp/
9797
temp/
9898

99-
# API Extractor outputs (keep docs/ and api-reports/ for GitHub Pages)
99+
# API Extractor outputs
100100
# temp/ - ignored (API Extractor temporary files)
101-
# docs/ - committed (for GitHub Pages)
101+
# docs/ - ignored (not using GitHub Pages)
102102
# api-reports/ - committed (for API tracking)
103+
docs/
103104

104105
# Claude Code memory file
105106
CLAUDE.md

GITHUB_PAGES_SETUP.md

Lines changed: 0 additions & 113 deletions
This file was deleted.

README.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,17 @@
44

55
[네오플 Open API](https://developers.neople.co.kr/)를 위한 포괄적인 TypeScript 타입 정의 라이브러리입니다.
66

7-
## 문서
8-
9-
- **[API Docs](https://crowrish.github.io/neople-openapi-types/)** - 전체 타입 정의 문서
7+
## 목차
8+
9+
- [설치](#설치)
10+
- [지원 게임](#지원-게임)
11+
- [기본 사용법](#기본-사용법)
12+
- [상세 사용 예시](#상세-사용-예시)
13+
- [API 엔드포인트 참조](#api-엔드포인트-참조)
14+
- [주요 타입 정의](#주요-타입-정의)
15+
- [에러 처리](#에러-처리)
16+
- [개발 정보](#개발-정보)
17+
- [버전 히스토리](#버전-히스토리)
1018

1119
## 설치
1220

@@ -19,9 +27,9 @@ npm install -D neople-openapi-types
1927
- **던전앤파이터 (Dungeon Fighter Online)** - 34개 API 엔드포인트
2028
- **사이퍼즈 (Cyphers)** - 11개 API 엔드포인트
2129

22-
## 사용법
30+
## 기본 사용법
2331

24-
### 기본 사용법
32+
### 타입 import 방법
2533

2634
```typescript
2735
import type {
@@ -39,9 +47,11 @@ import type {
3947
```
4048

4149

42-
### 사이퍼즈 API 사용 예시
50+
## 상세 사용 예시
51+
52+
### 사이퍼즈 API
4353

44-
#### 타입 정의만 사용하기
54+
#### 플레이어 검색
4555

4656
```typescript
4757
import type {
@@ -648,10 +658,9 @@ src/
648658
### 빌드
649659

650660
```bash
651-
npm run build # TypeScript 컴파일
652-
npm run build:full # 전체 빌드 + API 추출
653-
npm run docs:generate # API 문서 생성
654-
npm run clean # 빌드 결과물 정리
661+
npm run build # TypeScript 컴파일
662+
npm run build:full # 전체 빌드 + API 추출
663+
npm run clean # 빌드 결과물 정리
655664
```
656665

657666
## 버전 히스토리
@@ -661,13 +670,13 @@ npm run clean # 빌드 결과물 정리
661670
- 통합 타입 선언 파일 생성 (`dist/neople-openapi-types.d.ts`)
662671
- API 변경사항 자동 추적 (`api-reports/`)
663672
- 버전 간 호환성 검증
664-
- **[NEW]** 자동 생성 API 문서
665-
- GitHub Pages 지원 (`docs/` 폴더)
666-
- 모든 타입에 대한 상세 마크다운 문서
667-
- 온라인 문서: https://crowrish.github.io/neople-openapi-types/
673+
- **[IMPROVED]** 완전한 README.md 문서화
674+
- 목차 및 체계적인 섹션 구성
675+
- 상세한 사용 예시 및 API 가이드
676+
- GitHub Pages 대신 단일 문서로 통합
668677
- **[IMPROVED]** 개발 워크플로우 강화
669678
- TSDoc 설정 최적화 (`tsdoc.json`)
670-
- 새로운 npm 스크립트: `build:full`, `docs:generate`
679+
- 새로운 npm 스크립트: `build:full`, `api-extract`
671680
- 배포 전 API 호환성 자동 검증
672681

673682
### v0.4.0 - 코드 품질 관리
@@ -704,10 +713,11 @@ MIT License
704713

705714
이슈 및 풀 리퀘스트를 환영합니다!
706715

707-
## 지원
716+
## 링크
708717

709-
- [네오플 개발자센터](https://developers.neople.co.kr/)
710-
- [GitHub Issues](https://github.com/crowrish/neople-openapi-types/issues)
718+
- **[GitHub 저장소](https://github.com/crowrish/neople-openapi-types)** - 소스 코드 및 이슈 트래킹
719+
- **[npm 패키지](https://www.npmjs.com/package/neople-openapi-types)** - 설치 및 버전 정보
720+
- **[네오플 개발자센터](https://developers.neople.co.kr/)** - 공식 API 문서
711721

712722
---
713723

docs/_config.yml

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/index.md

Lines changed: 0 additions & 111 deletions
This file was deleted.

docs/neople-openapi-types.apierror.error.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)