feat: Add API Extractor and comprehensive documentation system (v0.5.0)#1
Merged
feat: Add API Extractor and comprehensive documentation system (v0.5.0)#1
Conversation
✨ New Features: - Microsoft API Extractor integration for API surface management - Auto-generated API documentation with GitHub Pages support - Comprehensive type documentation in docs/ folder - API compatibility tracking with api-reports/ 🔧 Improvements: - TSDoc configuration with custom @endpoint tag support - Enhanced build pipeline with documentation generation - New npm scripts: build:full, docs:generate - Version bump to 0.5.0 📖 Documentation: - GitHub Pages setup guide (GITHUB_PAGES_SETUP.md) - API usage examples (example-usage.md) - Online documentation link in README.md - Updated version history 🛠️ Technical Changes: - Added tsdoc.json for TSDoc configuration - Updated .gitignore for API Extractor outputs - Enhanced package.json with new scripts - Unified type declarations in dist/neople-openapi-types.d.ts 🎯 Benefits: - Professional API documentation website - Automated API compatibility tracking - Improved developer experience - Better maintenance workflow 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 개요
Microsoft API Extractor를 도입하여 전문적인 API 문서화 시스템을 구축하고 개발 워크플로우를 대폭 개선했습니다.
✨ 새로운 기능
📖 API 문서화 시스템
docs/폴더, 1000+ 파일)dist/neople-openapi-types.d.ts)🔧 개발 도구 개선
api-reports/)@endpoint태그 지원)build:full,docs:generate📋 변경사항
📦 새 파일들
api-extractor.json- API Extractor 설정tsdoc.json- TSDoc 설정 (커스텀 태그 정의)docs/- 자동 생성 API 문서 (GitHub Pages용)api-reports/- API 변경사항 추적 파일GITHUB_PAGES_SETUP.md- GitHub Pages 설정 가이드example-usage.md- API Extractor 활용 예시🔄 업데이트된 파일들
package.json- 버전 0.5.0, 새로운 스크립트, API Extractor 의존성README.md- GitHub Pages 링크, 버전 히스토리, 새로운 빌드 명령어.gitignore- API Extractor 출력 파일 관리🌐 GitHub Pages 문서
설정 완료 후 다음 URL에서 API 문서에 접근할 수 있습니다:
설정 방법:
main, Folder:/docs🔧 새로운 개발 워크플로우
빌드 명령어
자동화된 검증
prepublishOnly)🎁 개발자 경험 개선
✅ npm 사용자 (변화 없음)
dist/폴더만 포함 (문서 파일 제외)✅ 프로젝트 기여자 (대폭 개선)
🧪 테스트 완료
🎯 다음 단계
🤖 Generated with Claude Code