# Lark Dashboard SDK - Documentation Hub
**Version**: 1.0.0
**Status**: Production Ready
**Last Updated**: November 25, 2025
Welcome to the Lark Dashboard SDK! This is your single entry point to all documentation.
---
## Quick Navigation
### New to the SDK? Start Here
1. **[README.md](README.md)** - What is Lark Dashboard SDK?
2. **[QUICKSTART.md](QUICKSTART.md)** - Get running in 5 minutes
3. **[Tutorial 1: Your First Dashboard](DOCUMENTATION/TUTORIALS/01-YOUR-FIRST-DASHBOARD.md)** - Hands-on guide
### Need Something Specific?
- **[API Reference](API.md)** - Complete API documentation
- **[FAQ](DOCUMENTATION/FAQ.md)** - 70+ questions answered
- **[Quick Reference Card](QUICK_REFERENCE.md)** - Copy-paste code snippets
- **[Troubleshooting](DOCUMENTATION/REFERENCE/TROUBLESHOOTING.md)** - Fix common issues
---
## Documentation by Purpose
### I Want To Learn (Progressive Path)
**Tutorials** - Learn by building (1 hour total):
1. [Your First Dashboard (5 min)](DOCUMENTATION/TUTORIALS/01-YOUR-FIRST-DASHBOARD.md) - Installation & first chart
2. [Charts & Metrics (15 min)](DOCUMENTATION/TUTORIALS/02-CHARTS-AND-METRICS.md) - 8 chart types & KPIs
3. [Advanced Configuration (20 min)](DOCUMENTATION/TUTORIALS/03-ADVANCED-CONFIGURATION.md) - Filters & optimization
4. [MCP Integration (15 min)](DOCUMENTATION/TUTORIALS/04-MCP-INTEGRATION.md) - Claude Code setup
5. [Multi-Source Dashboards (30 min)](DOCUMENTATION/TUTORIALS/05-MULTI-SOURCE-DASHBOARDS.md) - Combine data
6. [Permissions (15 min)](DOCUMENTATION/TUTORIALS/06-PERMISSIONS.md) - Access control
7. [2025 Features (20 min)](DOCUMENTATION/TUTORIALS/07-2025-FEATURES.md) - Latest capabilities
### I Need Reference Material
**Core Documentation**:
- [API Reference](API.md) - Every method, parameter, and type
- [API Cheat Sheet](DOCUMENTATION/API_CHEATSHEET.md) - Quick copy-paste examples
- [Architecture Guide](DOCUMENTATION/ARCHITECTURE.md) - How it works internally
- [Best Practices](DOCUMENTATION/BEST_PRACTICES.md) - Production standards
- [Advanced Topics](DOCUMENTATION/ADVANCED_TOPICS.md) - Optimization & patterns
**Reference Guides** (in DOCUMENTATION/REFERENCE/):
- [Installation Guide](DOCUMENTATION/REFERENCE/INSTALLATION.md) - Setup details
- [Integration Guide](DOCUMENTATION/REFERENCE/INTEGRATION_GUIDE.md) - Connect with other systems
- [Migration Guide](DOCUMENTATION/REFERENCE/MIGRATION_GUIDE.md) - Upgrade from raw API
- [Troubleshooting](DOCUMENTATION/REFERENCE/TROUBLESHOOTING.md) - Common problems & solutions
### I'm Building Production Dashboards
Essential reading:
1. [Best Practices](DOCUMENTATION/BEST_PRACTICES.md) - Standards & patterns
2. [Advanced Topics](DOCUMENTATION/ADVANCED_TOPICS.md) - Performance & monitoring
3. [Deployment Guide](DEPLOYMENT.md) - Production deployment
4. [Upgrade Path](DOCUMENTATION/UPGRADE_PATH.md) - Migration strategies
### I Want to Use the AI Bot
The SDK includes an AI assistant bot for natural language dashboard creation:
- [Bot Documentation Hub](bot/README.md) - Main bot documentation
- [Bot Quick Start](bot/QUICK_START.md) - Set up in 15 minutes
- [Bot Setup Guide](bot/BOT_SETUP.md) - Detailed configuration
- [Conversation Examples](bot/examples/) - 5 real-world scenarios
---
## Documentation Structure
```
lark-dashboard-sdk/
├── 00-START-HERE.md ← You are here (entry point)
├── README.md ← What is the SDK?
├── QUICKSTART.md ← 5-minute quick start
├── API.md ← Complete API reference
├── DEPLOYMENT.md ← Deployment guide
├── QUICK_REFERENCE.md ← Code snippets
├── CHANGELOG.md ← Version history
├── CONTRIBUTING.md ← How to contribute
├── SUPPORT.md ← Get help
│
├── DOCUMENTATION/ ← Complete documentation library
│ ├── 00-START-HERE.md ← Documentation navigation
│ ├── README.md ← Documentation overview
│ ├── FAQ.md ← 70+ FAQs
│ ├── API_CHEATSHEET.md ← Quick API reference
│ ├── ARCHITECTURE.md ← System architecture
│ ├── BEST_PRACTICES.md ← Production standards
│ ├── ADVANCED_TOPICS.md ← Advanced patterns
│ ├── UPGRADE_PATH.md ← Migration guide
│ │
│ ├── TUTORIALS/ ← 7 progressive tutorials
│ │ ├── 01-YOUR-FIRST-DASHBOARD.md
│ │ ├── 02-CHARTS-AND-METRICS.md
│ │ ├── 03-ADVANCED-CONFIGURATION.md
│ │ ├── 04-MCP-INTEGRATION.md
│ │ ├── 05-MULTI-SOURCE-DASHBOARDS.md
│ │ ├── 06-PERMISSIONS.md
│ │ └── 07-2025-FEATURES.md
│ │
│ └── REFERENCE/ ← Reference documentation
│ ├── INSTALLATION.md
│ ├── INTEGRATION_GUIDE.md
│ ├── MIGRATION_GUIDE.md
│ └── TROUBLESHOOTING.md
│
└── bot/ ← AI Bot documentation
├── README.md ← Bot overview
├── QUICK_START.md ← Bot quick start
├── BOT_SETUP.md ← Detailed setup
├── INDEX.md ← Bot documentation index
├── TROUBLESHOOTING.md ← Bot troubleshooting
└── examples/ ← Conversation examples
├── conversation-1-sales-dashboard.md
├── conversation-2-team-performance.md
├── conversation-3-error-recovery.md
├── conversation-4-realtime-analytics.md
└── conversation-5-multi-source-dashboard.md
```
---
## Quick Answers to Common Questions
**How do I install?**
```bash
npm install @hypelab/lark-dashboard-sdk
```
See [QUICKSTART.md](QUICKSTART.md)
**How do I create a chart?**
```typescript
import { LarkDashboardClient, ChartBlockBuilder } from '@hypelab/lark-dashboard-sdk';
const chart = ChartBlockBuilder.bar()
.dataSource(appToken, tableId)
.xAxis({ fieldName: 'Category' })
.yAxis([{ fieldName: 'Value', aggregation: 'SUM' }])
.build();
```
See [Tutorial 2](DOCUMENTATION/TUTORIALS/02-CHARTS-AND-METRICS.md)
**How do I use with Claude?**
```json
{
"mcpServers": {
"lark-dashboard": {
"command": "npx",
"args": ["-y", "@hypelab/lark-dashboard-sdk"]
}
}
}
```
See [Tutorial 4](DOCUMENTATION/TUTORIALS/04-MCP-INTEGRATION.md)
**Where are the examples?**
- Code examples in [API.md](API.md)
- Tutorial examples in [DOCUMENTATION/TUTORIALS/](DOCUMENTATION/TUTORIALS/)
- Bot conversation examples in [bot/examples/](bot/examples/)
**Something not working?**
1. Check [FAQ](DOCUMENTATION/FAQ.md)
2. Read [Troubleshooting](DOCUMENTATION/REFERENCE/TROUBLESHOOTING.md)
3. Search [GitHub Issues](https://github.com/HypelivebytheHYPER/lark-dashboard-sdk/issues)
4. Get [Support](SUPPORT.md)
---
## What's New in v1.0.0
- **7 Block Types**: Charts, Metrics, Views, Text, Lists, Tab Pages, Filters
- **8 Chart Types**: Bar, Line, Pie, Scatter, Area, Funnel, Radar, Progress
- **MCP Server**: Native Claude Code integration
- **Type-Safe**: Full TypeScript support
- **Production Ready**: Error handling, retries, logging
- **2025 Features**: Latest Lark dashboard capabilities
See [CHANGELOG.md](CHANGELOG.md) for complete version history.
---
## Support & Community
- **Documentation**: You're reading it!
- **Issues**: [GitHub Issues](https://github.com/HypelivebytheHYPER/lark-dashboard-sdk/issues)
- **Support**: [SUPPORT.md](SUPPORT.md)
- **Contributing**: [CONTRIBUTING.md](CONTRIBUTING.md)
- **License**: MIT
---
## Ready to Start?
Choose your path:
**🚀 Quick Start (5 min)**: [QUICKSTART.md](QUICKSTART.md)
**📚 Full Tutorial (1 hour)**: [Tutorial 1](DOCUMENTATION/TUTORIALS/01-YOUR-FIRST-DASHBOARD.md)
**🤖 AI Bot (15 min)**: [Bot Quick Start](bot/QUICK_START.md)
**📖 API Reference**: [API.md](API.md)
---
**Happy Dashboard Building!** 🎉
