v0.10.0 - API Documentation Generation
🎉 Release v0.10.0 - API Documentation Generation
✨ What's New
- 📚 API Documentation: Comprehensive TypeDoc-powered API documentation
- 🌐 Live Docs: Documentation automatically deployed at https://zheruel.github.io/nano-string-utils/
- 🎮 Interactive Playground: Test functions directly in the browser
- 🚀 GitHub Pages Integration: Automatic deployment via GitHub Actions
📝 Changes
- Added TypeDoc configuration for generating API documentation from JSDoc comments
- Created documentation site structure with Vite for future enhancements
- Added GitHub Actions workflow (
.github/workflows/docs.yml) for automatic deployment - New npm scripts:
docs,docs:dev,docs:build,docs:preview - All existing functions have complete JSDoc with descriptions, parameters, returns, and examples
- Added README to docs-src directory with documentation maintenance instructions
- Updated CLAUDE.md with documentation generation guidelines for new functions
📦 Installation
```bash
npm install [email protected]
```